Star
API reference

Provider webhooks

Each transport with a webhookPath gets a route that providers call back. Point the provider's webhook setting at it.

The path comes from the transport, for example /webhooks/resend. Routes exist only on deployments running the api service with that transport registered. See each provider package for its path and secret.

Receive provider events

POST/{webhookPath}

Auth: The transport's signature check (verifyWebhook). No API key.

Verifies the signature over the raw body, then records each event against the message it's about. Unsubscribes, complaints and hard bounces also suppress the address. Events for unknown messages are dropped. Repeats are no-ops, so provider retries are safe.

Responses

{
  "success": true
}
{
  "error": "unauthorized",
  "message": "Invalid webhook signature"
}
{
  "error": "not_implemented",
  "message": "Webhook signature verification is not implemented for this provider"
}
{
  "error": "internal_error"
}

Verification handshake

GET/{webhookPath}

Auth: None.

Only for transports with verifyWebhookChallenge, such as WhatsApp. Plain-text responses.

Responses

1158201444
Forbidden
internal_error