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>
DELETEhttps://hermeticor.com/v1/integrations/secrets/{name}

Delete a secret no endpoint uses

Parameters

namestringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

GEThttps://hermeticor.com/v1/webhooks/journal

Events after an offset, optionally as one endpoint would have received them

Parameters

limitintegerquery
= 100
afterintegerquery
endpointIdstringquery
topicstringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "offset": 0,
      "id": "string",
      "topic": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "data": {}
    }
  ],
  "nextOffset": 0
}
Schema
itemsItemsItem69[]required
Show child parameters
offsetintegerrequired
idstringrequired
topicstringrequired
createdAtstringrequired
datarequired
nextOffsetintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

POSThttps://hermeticor.com/v1/webhooks/journal/snapshots

Write the current state of listed contacts into the journal as crm.snapshot entries, or freeze a segment and queue its entries for the worker

Request body

application/json
segmentIdstring
profileIdsstring[]
{
  "segmentId": "string",
  "profileIds": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/webhooks/journal/snapshots" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"segmentId":"string","profileIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "snapshotId": "string",
  "records": 0,
  "entries": 0,
  "queued": true
}
Schema
snapshotIdstringrequired
recordsintegerrequired
entriesintegerrequired
queuedbooleanrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

GEThttps://hermeticor.com/v1/webhooks/journal/bounds

Code samples

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

Responses

200 Default Response
Example
{
  "earliest": 0,
  "latest": 0
}
Schema
earliestintegerrequired
latestintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

GEThttps://hermeticor.com/v1/webhooks/journal/earliest/{count}

Parameters

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

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "offset": 0,
      "id": "string",
      "topic": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "data": {}
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem69[]required
Show child parameters
offsetintegerrequired
idstringrequired
topicstringrequired
createdAtstringrequired
datarequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

GEThttps://hermeticor.com/v1/webhooks/journal/latest/{count}

Parameters

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

Code samples

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

Responses

200 Default Response

Same as 200 · GET /v1/webhooks/journal/earliest/{count}

4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

POSThttps://hermeticor.com/v1/webhooks/journal/batch-read

Request body

application/json
offsetsinteger[]required
{
  "offsets": [
    0
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/webhooks/journal/batch-read" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"offsets":[0]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "offset": 0,
      "id": "string",
      "topic": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "data": {}
    }
  ]
}
Schema
itemsItemsItem69[]required
Show child parameters
offsetintegerrequired
idstringrequired
topicstringrequired
createdAtstringrequired
datarequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

GEThttps://hermeticor.com/v1/webhooks/summary

Parameters

endpointIdstringquery
sincestringquery
untilstringquery

Code samples

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

Responses

200 Default Response
Example
{
  "total": 0,
  "succeeded": 0,
  "failed": 0,
  "pending": 0,
  "avgLatencyMs": 0
}
Schema
totalintegerrequired
succeededintegerrequired
failedintegerrequired
pendingintegerrequired
avgLatencyMsintegerrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

GEThttps://hermeticor.com/v1/webhooks/summary-by-date

Parameters

endpointIdstringquery
sincestringquery
untilstringquery
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/summary-by-date" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "total": 0,
      "succeeded": 0,
      "failed": 0,
      "pending": 0,
      "avgLatencyMs": 0,
      "date": "string"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
totalintegerrequired
succeededintegerrequired
failedintegerrequired
pendingintegerrequired
avgLatencyMsintegerrequired
datestringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

GEThttps://hermeticor.com/v1/webhooks/deliveries/export

Download the delivery log (NDJSON with payloads, or CSV)

Parameters

endpointIdstringquery
statusstringquery
pending | succeeded | failed
sincestringquery
untilstringquery
formatstringquery
ndjson | csv = ndjson

Code samples

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

Responses

200 Default Response
{}
4XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

5XX Default Response

Same as 4XX · DELETE /v1/integrations/secrets/{name}

Updated