Webhook endpoints
A Webhook Endpoint is an HTTPS receiver that events of its environment whose type matches `spec.event_types` are delivered to, signed per…
A Webhook Endpoint is an HTTPS receiver that events of its environment whose type matches spec.event_types are delivered to, signed per Standard Webhooks (webhook-id, webhook-timestamp, webhook-signature). Failures retry on the fixed schedule (immediately, 5s, 5m, 30m, 2h, 5h, 10h, 10h); exhausted deliveries dead-letter; an endpoint whose attempts keep failing for five days is disabled.
Service Sylphx Events · Resource type events.sylphx.com/WebhookEndpoint · Name pattern orgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/webhook_endpoints/{webhook_endpoint}. |
uid | string | whe_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | WebhookEndpointSpec | Desired state. Required. |
status | WebhookEndpointStatus | Observed state. 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 endpoint. |
GET | list | Lists webhook endpoints. |
POST | create | Creates a webhook endpoint. |
PATCH | update | Updates a webhook endpoint. |
DELETE | delete | Deletes a webhook endpoint. |
POST | replay | Redelivers every dead-lettered delivery to the endpoint created in a time range, each as a new attempt. |
POST | rotate_secret | Replaces the endpoint's signing secret and returns the new one, once (status.signing_secret). For 24 hours deliveries carry a signature with each secret, so a receiver can switch without dropping one. |
POST | test | Sends a test event (type sylphx.webhook.test) to the endpoint alone, through the same signing, retries, and delivery log as any other event. |
get
Gets a webhook endpoint.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint · scope events:read · effect read · Request, response and examples
list
Lists webhook endpoints.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints · scope events:read · effect read · paginated · Request, response and examples
create
Creates a webhook endpoint.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints · scope events:write · effect write · Request, response and examples
update
Updates a webhook endpoint.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint · scope events:write · effect write · Request, response and examples
delete
Deletes a webhook endpoint.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint · scope events:write · effect destructive · Request, response and examples
replay
Redelivers every dead-lettered delivery to the endpoint created in a time range, each as a new attempt.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:replay · scope events:write · effect write · Request, response and examples
rotate_secret
Replaces the endpoint's signing secret and returns the new one, once (status.signing_secret). For 24 hours deliveries carry a signature with each secret, so a receiver can switch without dropping one.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:rotateSecret · scope events:write · effect write · Request, response and examples
test
Sends a test event (type sylphx.webhook.test) to the endpoint alone, through the same signing, retries, and delivery log as any other event.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/webhook_endpoints/webhook-endpoint:test · scope events:write · effect write · Request, response and examples