Webhook endpoints
Manage endpoint destinations, signing secrets and test events.
List webhook endpoints
Returns public endpoint metadata. Signing secrets are never returned by reads.
Create webhook endpoint
name is trimmed (1โ80 characters). Description is at most 300 characters. Destinations require public HTTPS on port 443 and pass DNS/address checks. Save signingSecret now: it is returned once. Optional payloadMapping shapes the complete body. Omit it or use null for the standard body.
Delete webhook endpoint
Signed-in browser session or scoped API key. Refreshes affected domain routing. Related delivery history is removed with the endpoint.
Inspect webhook endpoint
Returns the account's endpoint and its content-free delivery summaries, 10 per page. API keys also need deliveries:read to see delivery history. Otherwise deliveries is [] and pagination is null.
Rotate webhook signing secret
Rotates the endpoint signing secret. The new secret is returned once. Accepted messages continue to use their pinned signing-key version.
Update webhook endpoint
Updates any supplied endpoint fields: name, URL, description, status, and payload mapping. Newly accepted messages pin the endpoint destination and shaping revision. Pending deliveries keep those pinned revisions. Pausing an endpoint stops sends.
Preview a draft webhook payload mapping
Evaluates a draft against a supplied sample object without saving or sending. Endpoint must belong to the authenticated account. Null mapping returns the standard body. Missing optional fields are reported in missingPaths, separate from validation errors.
Queue a test webhook
No body. Endpoint must be active with a saved revision and signing secret. Asynchronously queues a test payload with type: email.test, schema_version: 2026-09-01, and a 24-hour deadline. It is not a parsed email.received payload. Applies the saved payload mapping, which can omit these fields. A 202 response confirms scheduling. Inspect the delivery to determine success.