Skip to content
Console
On this page

Webhook deliveries

A Webhook Delivery is one event on its way to a Webhook Endpoint, with every attempt and its immutable receipt.

A Webhook Delivery is one event on its way to a Webhook Endpoint, with every attempt and its immutable receipt. A receipt is evidence of an endpoint response, never of a human reading.

Service Sylphx Events · Resource type events.sylphx.com/WebhookDelivery · Name pattern orgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}/webhook_deliveries/{webhook_delivery} · Shape record

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}/webhook_deliveries/{webhook_delivery}.
uidstringwhd_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
eventstringThe retained Event delivered. Unset when its admission environment is unknown, differs from the endpoint's environment, or the Event is gone. Output only.
subscriptionstringThe sole retained Subscription association. Unset when zero or multiple Subscriptions share this delivery; use subscriptions for the complete set. Output only.
stateDeliveryStateThe delivery state. Output only. One of pending, delivered, dead_lettered, cancelled.
attemptsDeliveryAttempt[]Every attempt, oldest first. Output only.
next_attempt_timetimestampWhen the next attempt is due. Output only.
event_typestringThe CloudEvents type of the event delivered. Output only.
subscriptionsstring[]Every retained Subscription association in the endpoint's environment, ordered by resource name. Direct and test deliveries can have none. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a webhook delivery.
GETlistLists webhook deliveries.
POSTreplayRedelivers one delivery now, as a new attempt.

get

Gets a webhook delivery.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint/webhook_deliveries/webhook-delivery · scope events:read · effect read · Request, response and examples

list

Lists webhook deliveries.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint/webhook_deliveries · scope events:read · effect read · paginated · Request, response and examples

replay

Redelivers one delivery now, as a new attempt.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint/webhook_deliveries/webhook-delivery:replay · scope events:write · effect write · Request, response and examples