Webhook Deliveries
Register where events are delivered, roll the signing secret without dropping a delivery, and see how the destination is behaving.
List webhook delivery history
Retry a pending webhook delivery now
ModelsExpand Collapse
Delivery object { id, attempt_history_complete, attempts, 11 more } One webhook delivery and every retained applied attempt belonging to it.
One webhook delivery and every retained applied attempt belonging to it.
True only when every spent attempt has a retained applied verdict and collection covered this delivery from creation.
Attempts spent by the delivery machine, including leases that expired without an applied verdict.
Present only while state is pending: the instant the next attempt
becomes due. A value in the future is a delivery backing off after a
failed attempt; a value at or before now is a delivery that is due and
waiting — usually behind an earlier delivery to the same endpoint and
chat. Deliveries to one endpoint and chat are sent in the order their
events were recorded. A message.received for a message carrying
attachments can be recorded once every attachment has been captured or has
failed, or ten minutes after the message arrived. It can therefore
follow deliveries for later messages of the same chat, and carry a lower
data.seq_from than an event you already received: seq_from can
decrease relative to arrival. Never discard such an event as stale:
deduplicate by the event id, order a conversation by data.seq_from,
and for live processing buffer briefly or reconcile with
GET /v1/chats/{chat}/events. POST /v1/webhook_deliveries/{delivery}/retry
moves a future value to now.
DeliveryAttempt object { attempt, attempt_completed_at, attempt_started_at, 9 more } One applied attempt to deliver an account event to a webhook endpoint.
One applied attempt to deliver an account event to a webhook endpoint.
DeliveryPage object { attempt_history_coverage_started_at, data, has_more, 3 more } A bounded page of webhook deliveries. Parent deliveries are never split across pages.
A bounded page of webhook deliveries. Parent deliveries are never split across pages.
Inclusive instant when attempt-history collection began. Earlier deliveries cannot claim complete attempt history.
True only when every spent attempt has a retained applied verdict and collection covered this delivery from creation.
Attempts spent by the delivery machine, including leases that expired without an applied verdict.
Present only while state is pending: the instant the next attempt
becomes due. A value in the future is a delivery backing off after a
failed attempt; a value at or before now is a delivery that is due and
waiting — usually behind an earlier delivery to the same endpoint and
chat. Deliveries to one endpoint and chat are sent in the order their
events were recorded. A message.received for a message carrying
attachments can be recorded once every attachment has been captured or has
failed, or ten minutes after the message arrived. It can therefore
follow deliveries for later messages of the same chat, and carry a lower
data.seq_from than an event you already received: seq_from can
decrease relative to arrival. Never discard such an event as stale:
deduplicate by the event id, order a conversation by data.seq_from,
and for live processing buffer briefly or reconcile with
GET /v1/chats/{chat}/events. POST /v1/webhook_deliveries/{delivery}/retry
moves a future value to now.
True when successful delivery detail may have been swept from this account partition.