Webhooks

Create a webhook subscription

Creates a signed outbound webhook subscription and returns the signing secret once. The caller must also have read scopes for the selected event families. A workspace can have up to 20 webhook subscriptions, including disabled subscriptions.

post/v1/webhook-subscriptions

Request

  • Base URL: https://api.mailrith.com
  • URL: https://api.mailrith.com/v1/webhook-subscriptions
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional idempotency key to retry the request safely. It must not exceed 256 UTF-8 bytes.

Request body

namestring required
urlstring required

Public HTTPS destination URL for signed event delivery. Localhost, private network, link-local, and reserved destinations are not accepted.

event_patternsstring[] required

Events or wildcard patterns to deliver through this outbound webhook destination.

status'active' | 'disabled'

Response

Webhook subscription created

Changes

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