webhooks

Embed
Preview of the card
<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>
GEThttps://hermeticor.com/v1/webhooks/topics

Every webhook topic with description, payload schema and example

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/webhooks/topics" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "topic": "string",
      "category": "string",
      "description": "string",
      "schema": {},
      "example": {}
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem67[]required
Show child parameters
topicstringrequired
categorystringrequired
descriptionstringrequired
schemaobjectrequired
exampleobjectrequired
nextCursorstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

GEThttps://hermeticor.com/v1/webhooks/topics/{topic}

Parameters

topicstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/webhooks/topics/{topic}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "topic": "string",
  "category": "string",
  "description": "string",
  "schema": {},
  "example": {}
}
Schema
topicstringrequired
categorystringrequired
descriptionstringrequired
schemaobjectrequired
exampleobjectrequired
4XX Default Response

Same as 4XX · GET /v1/webhooks/topics

5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

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

Send a topic's example payload to this endpoint (signed like a real delivery, logged, never retried)

Parameters

idstringpathrequired

Request body

application/json
topicstringrequired
{
  "topic": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/webhooks/endpoints/{id}/test-topic" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"topic":"string"}'
TypeScript
Python
Go
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 · GET /v1/webhooks/topics

5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

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

Parameters

limitintegerquery
= 50
cursorstringquery
statusstringquery
pending | succeeded | failed
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/webhooks/endpoints/{id}/deliveries" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "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"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsPostV1WebhooksEndpointsByIdTestResponse[]required
Show child parameters
idstringrequired
endpointIdstringrequired
outboxIdstringrequired
topicstringrequired
attemptintegerrequired
statusstringrequired
pending | succeeded | failed
responseCodeintegerrequired
latencyMsintegerrequired
errorstringrequired
nextAttemptAtstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/webhooks/topics

5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

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

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/webhooks/endpoints/{id}/resume" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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 · GET /v1/webhooks/topics

5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

POSThttps://hermeticor.com/v1/webhooks/endpoints/{id}/retrigger-failed

Requeue this endpoint's failed deliveries with a fresh retry window

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/webhooks/endpoints/{id}/retrigger-failed" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

202 Default Response
Example
{
  "requeued": 0
}
Schema
requeuedintegerrequired
4XX Default Response

Same as 4XX · GET /v1/webhooks/topics

5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

GEThttps://hermeticor.com/v1/integrations/secrets

Secret names (values are never returned)

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/integrations/secrets" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem68[]required
Show child parameters
idstringrequired
namestringrequired
descriptionstringrequired
createdAtstringrequired
updatedAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/webhooks/topics

5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

PUThttps://hermeticor.com/v1/integrations/secrets/{name}

Create or replace a secret

Parameters

namestringpathrequired

Request body

application/json
valuestringrequired
descriptionstring
{
  "value": "string",
  "description": "string"
}

Code samples

cURL
curl -X PUT "https://hermeticor.com/v1/integrations/secrets/{name}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":"string","description":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
descriptionstringrequired
createdAtstringrequired
updatedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/webhooks/topics

5XX Default Response

Same as 4XX · GET /v1/webhooks/topics

Updated