v2

latestOpenAPI 3.1.0MIT2026-07-26105151330.5 KB

Webhooks

Create Webhook

Create a new webhook endpoint. Returns the webhook configuration including a secret for signature verification. The secret is only shown once. Requires API key with webhook:write.

post/v1/webhooks

Request body

urlstring uri required

The webhook endpoint URL (must be HTTPS)

eventsstring[] required

Array of event types to subscribe to (e.g., email.generation.completed)

descriptionstring

Optional description for the webhook

customHeadersobject

Optional custom headers to include in webhook requests

Response

Webhook created

successboolean required

errorstring nullable