webhooks

Embed

<a href="https://hermeticor.com/docs/ref-webhooks"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/4870b1c4-ef67-427a-9cf5-cfc37c3c2402/social-card.svg?v=3e7ae33eec8b" alt="webhooks" width="600" height="315"></a>

POSThttps://hermeticor.com/v1/webhooks/endpoints

Request body

application/json

urlstringrequired

topicsstring[]required

descriptionstring

filtersFiltersItem2[]

Show child parameters

idstring

pathstringrequired

opstringrequired

eq | neq | in | contains | exists | gt | lt

value

listIdsstring[]

sourcesstring[]

sequenceIdsstring[]

bodyTemplatestring

authHeadersAuthHeadersItem[]

Show child parameters

headerstringrequired

secretNamestringrequired

prefixstring

throttleSecondsinteger

throttleTopicsstring[]

{
  "url": "string",
  "topics": [
    "string"
  ],
  "description": "string",
  "filters": [
    {
      "id": "string",
      "path": "string",
      "op": "eq",
      "value": {}
    }
  ],
  "listIds": [
    "string"
  ],
  "sources": [
    "string"
  ],
  "sequenceIds": [
    "string"
  ],
  "bodyTemplate": "string",
  "authHeaders": [
    {
      "header": "string",
      "secretName": "string",
      "prefix": "string"
    }
  ],
  "throttleSeconds": 0,
  "throttleTopics": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/webhooks/endpoints" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","topics":["string"],"description":"string","filters":[{"id":"string","path":"string","op":"eq","value":{}}],"listIds":["string"],"sources":["string"],"sequenceIds":["string"],"bodyTemplate":"string","authHeaders":[{"header":"string","secretName":"string","prefix":"string"}],"throttleSeconds":0,"throttleTopics":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "url": "string",
  "topics": [
    "string"
  ],
  "description": "string",
  "filters": [
    {
      "id": "string",
      "path": "string",
      "op": "eq",
      "value": {}
    }
  ],
  "listIds": [
    "string"
  ],
  "sources": [
    "string"
  ],
  "sequenceIds": [
    "string"
  ],
  "bodyTemplate": "string",
  "authHeaders": [
    {
      "header": "string",
      "secretName": "string",
      "prefix": "string"
    }
  ],
  "throttleSeconds": 0,
  "throttleTopics": [
    "string"
  ],
  "status": "active",
  "consecutiveFailures": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "secret": "string"
}

Schema

idstringrequired

urlstringrequired

topicsstring[]required

descriptionstringrequired

filtersFiltersItem[]required

Show child parameters

idstring

pathstringrequired

opstringrequired

eq | neq | in | contains | exists | gt | lt

value

listIdsstring[]required

sourcesstring[]required

sequenceIdsstring[]required

bodyTemplatestringrequired

authHeadersAuthHeadersItem2[]required

Show child parameters

headerstringrequired

secretNamestringrequired

prefixstring

throttleSecondsintegerrequired

throttleTopicsstring[]required

statusstringrequired

active | disabled

consecutiveFailuresintegerrequired

createdAtstringrequired

updatedAtstringrequired

secretstringrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

DELETEhttps://hermeticor.com/v1/webhooks/endpoints

Delete every webhook subscription in the workspace (pending deliveries are cancelled)

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/webhooks/endpoints" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "deleted": 0
}

Schema

deletedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

5XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

GEThttps://hermeticor.com/v1/webhooks/endpoints/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/webhooks/endpoints/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "url": "string",
  "topics": [
    "string"
  ],
  "description": "string",
  "filters": [
    {
      "id": "string",
      "path": "string",
      "op": "eq",
      "value": {}
    }
  ],
  "listIds": [
    "string"
  ],
  "sources": [
    "string"
  ],
  "sequenceIds": [
    "string"
  ],
  "bodyTemplate": "string",
  "authHeaders": [
    {
      "header": "string",
      "secretName": "string",
      "prefix": "string"
    }
  ],
  "throttleSeconds": 0,
  "throttleTopics": [
    "string"
  ],
  "status": "active",
  "consecutiveFailures": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

urlstringrequired

topicsstring[]required

descriptionstringrequired

filtersFiltersItem[]required

Show child parameters

idstring

pathstringrequired

opstringrequired

eq | neq | in | contains | exists | gt | lt

value

listIdsstring[]required

sourcesstring[]required

sequenceIdsstring[]required

bodyTemplatestringrequired

authHeadersAuthHeadersItem2[]required

Show child parameters

headerstringrequired

secretNamestringrequired

prefixstring

throttleSecondsintegerrequired

throttleTopicsstring[]required

statusstringrequired

active | disabled

consecutiveFailuresintegerrequired

createdAtstringrequired

updatedAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

5XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

DELETEhttps://hermeticor.com/v1/webhooks/endpoints/{id}

Parameters

idstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/webhooks/endpoints/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

5XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

PATCHhttps://hermeticor.com/v1/webhooks/endpoints/{id}

Parameters

idstringpathrequired

Request body

application/json

urlstring

topicsstring[]

filtersFiltersItem2[]

Show child parameters

idstring

pathstringrequired

opstringrequired

eq | neq | in | contains | exists | gt | lt

value

listIdsstring[]

sourcesstring[]

sequenceIdsstring[]

descriptionstring

bodyTemplatestring

authHeadersAuthHeadersItem[]

Show child parameters

headerstringrequired

secretNamestringrequired

prefixstring

throttleSecondsinteger

throttleTopicsstring[]

statusstring

active | disabled

{
  "url": "string",
  "topics": [
    "string"
  ],
  "filters": [
    {
      "id": "string",
      "path": "string",
      "op": "eq",
      "value": {}
    }
  ],
  "listIds": [
    "string"
  ],
  "sources": [
    "string"
  ],
  "sequenceIds": [
    "string"
  ],
  "description": "string",
  "bodyTemplate": "string",
  "authHeaders": [
    {
      "header": "string",
      "secretName": "string",
      "prefix": "string"
    }
  ],
  "throttleSeconds": 0,
  "throttleTopics": [
    "string"
  ],
  "status": "active"
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/webhooks/endpoints/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"string","topics":["string"],"filters":[{"id":"string","path":"string","op":"eq","value":{}}],"listIds":["string"],"sources":["string"],"sequenceIds":["string"],"description":"string","bodyTemplate":"string","authHeaders":[{"header":"string","secretName":"string","prefix":"string"}],"throttleSeconds":0,"throttleTopics":["string"],"status":"active"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/webhooks/endpoints/{id}

4XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

5XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

POSThttps://hermeticor.com/v1/webhooks/endpoints/{id}/rotate-secret

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/webhooks/endpoints/{id}/rotate-secret" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "secret": "string"
}

Schema

secretstringrequired

4XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

5XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

POSThttps://hermeticor.com/v1/webhooks/endpoints/{id}/test

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/webhooks/endpoints/{id}/test" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "endpointId": "string",
  "outboxId": "string",
  "topic": "string",
  "attempt": 0,
  "status": "pending",
  "responseCode": 0,
  "latencyMs": 0,
  "error": "string",
  "nextAttemptAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

endpointIdstringrequired

outboxIdstringrequired

topicstringrequired

attemptintegerrequired

statusstringrequired

pending | succeeded | failed

responseCodeintegerrequired

latencyMsintegerrequired

errorstringrequired

nextAttemptAtstringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

5XX Default Response

Same as 4XX · POST /v1/webhooks/endpoints

Next part

Updated Nov 8, 2026

Was this page helpful?