Webhooks

Create a webhook

Register an endpoint to receive HMAC-signed deliveries for the events named in event_types.

The response carries the signing secret ONCE. It is shown here and by POST /api/v1/webhooks/{id}/rotate-secret, and by nothing else — no endpoint reads it back, so store it now. A secret you have lost is replaced by rotating, not recovered.

Requires the webhooks:write scope — Create, edit, and delete your webhook endpoints.

post/api/v1/webhooks

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: webhooks:write)

Request body

event_typesstring[] required
urlstring uri required

Response

The created webhook and its one-time signing secret

secretstring required

The signing secret, shown EXACTLY ONCE. Store it now — no endpoint returns it again.

Changes

No recorded changes to this operation across all 1 revision of this API.