Webhooks

Create webhook

Register a new HTTPS webhook endpoint. Optional Authorization or X-API-Key values are encrypted at rest and included in every delivery. The signing secret is returned only once. Maximum 5 webhooks per account. A webhook created by a mailbox-confined token is confined to the same mailboxes: it receives no mail event from any other mailbox.

post/api/webhooks

Request

  • Base URL: https://domani.run
  • URL: https://domani.run/api/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

HTTPS URL that will receive webhook POST requests

eventsstring[] required

Event types to subscribe to. Use GET /api/webhooks/events to list available types.

headersobject

Optional encrypted auth headers. Only Authorization and X-API-Key are accepted.

Response

Webhook created. Secret is included only in this response.

idstring
urlstring uri
eventsstring[]
secretstring

HMAC-SHA256 signing secret (shown once)

activeboolean
header_namesstring[]

Configured auth header names; values are never returned

created_atstring date-time
hintstring

Changes

No recorded changes to this operation across all 2 revisions of this API.