Skip to main content
POST
Send an event to a Loop (key in the URL)

Headers

X-Webhook-Correlation-Key
string

Events with the same key continue one Session; without it (or a key in the body) each event opens its own.

Maximum string length: 500
X-Webhook-Event-Id
string

The sender's id for the event; a retry with the same id is answered as a duplicate and queued once. Without one (or an id in the body), every POST is a new event.

Maximum string length: 240
X-Webhook-Event-Source
string

Which system sent the event, shown with it.

Maximum string length: 80
X-Signature-256
string

For a sender you write: hex HMAC-SHA256 of the exact body bytes, keyed with the Loop's webhook key (or its signing secret), optionally prefixed sha256=. X-Signature is read the same way.

Path Parameters

publicToken
string
required

The webhook's public token: the last segment of the webhook URL createReasonLoop returns. It names the webhook and authenticates nothing.

key
string
required

The Loop's webhook key, for a sender that only takes a URL.

Response

Accepted, or a duplicate of an event already accepted.

accepted
boolean
required
duplicate
boolean
required

True when an event with the same id already arrived: this one is not queued again, and the earlier event's ids are returned.

event_id
string
required

The stored event.

work_item_id
string | null
required

The unit of work its correlation key groups it into: one Session per work item.