Webhooks

Message received

A message arrived for the agent account on one of its channels. The event leaves out the content of a message Artil keeps; read it with its id. One it keeps no copy of comes whole.

postWebhookmessage.received

Headers

webhook-idstring required

The event's id, the same on every retry

webhook-timestampstring required

When Artil signed the delivery, in Unix seconds

webhook-signaturestring required

v1, followed by the base64 HMAC-SHA256 of the id, timestamp and body under the webhook's secret, as Standard Webhooks describes

Payload

eventIdstring required

The event's id, sent as webhook-id and kept on every retry

name'message.received' required
timestampstring date-time required

When the event happened

cursorstring required

Where delivery stands after this event

Response

The event arrived; Artil sends the next one

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.