Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
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
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}/webhook_deliveries/{webhook_delivery}. |
uid | string | whd_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
event | string | The Event delivered. Output only. |
subscription | string | The Subscription that fanned it out. Output only. |
state | DeliveryState | The delivery state. Output only. One of pending, delivered, dead_lettered, cancelled. |
attempts | DeliveryAttempt[] | Every attempt, oldest first. Output only. |
next_attempt_time | timestamp | When the next attempt is due. Output only. |
event_type | string | The CloudEvents type of the event delivered. 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a webhook delivery. |
GET | list | Lists webhook deliveries. |
POST | replay | Redelivers 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