Webhooks

Create a webhook

Registers a URL to receive events. The answer carries the signing secret once; every delivery is signed with it (HMAC-SHA256 over the body) so the receiver can verify Sendora sent it. A second secret can be created later to roll the first one.

post/v1/webhooks

Request

  • Base URL: https://api.sendora.se
  • URL: https://api.sendora.se/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring required

An https URL on a public host, without credentials or a fragment.

eventsstring[]

The events to deliver; every event when left out.

streamIdstring uuid

Limits the message events to one stream of the server; every stream when left out. Cap events, on sending and on received mail, concern the server or the account and arrive either way.

inboundContent'full' | 'reference'

How the inbound event carries a received message: full sends the parsed message with the event; reference sends ids and sizes only, for you to fetch. full when left out.

Response

The new webhook with its signing secret, shown this once.

webhookIdstring uuid required
urlstring required

Where the events are posted.

eventsstring[] required
streamIdstring uuid nullable required

The one stream whose message events it receives; null for every stream.

enabledboolean required

False while switched off in the dashboard; nothing is queued for it then.

inboundContent'full' | 'reference' required

How the inbound event carries a received message: the parsed message, or a reference.

createdAtstring date-time required
secretstring required

The signing secret, shown this once.

Changes

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