webhooks

Register a webhook on a mailbox

events defaults to ["email.received"] when omitted. The response includes the HMAC secret — this is the ONLY time it's returned; GET .../webhooks never includes it.

post/v1/mailboxes/{mailbox_id}/webhooks

Request

  • Base URL: https://mbag.ai/api
  • URL: https://mbag.ai/api/v1/mailboxes/{mailbox_id}/webhooks
  • Auth: HTTP bearer

Path parameters

mailbox_idinteger required

Request body

eventsstring[]

Defaults to ["email.received"] when omitted.

urlstring required

Must start with http:// or https://.

Response

Webhook registered.

created_atstring date-time required
customer_idinteger required
eventsstring[] required
idinteger required
is_activeboolean required
mailbox_idinteger required
secretstring required

HMAC secret for verifying the X-Mailbuttons-Signature header on delivered webhooks.

urlstring required

Changes

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