webhooks

Create a webhook

Scope: manage. Not for pending keys. url must be https (http://localhost only in development). The response includes secret once; store it to verify signatures.

post/v1/webhooks

Request

  • Base URL: https://botmail.pro
  • URL: https://botmail.pro/v1/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bm_session

Request body

urlstring uri required
mailbox_idstring

Only this mailbox. Omit for every mailbox the credential can access.

eventsEventType[]

Default ["message.received"].

Response

Created.

idstring required
urlstring uri required
mailbox_idstring nullable required

Null = every mailbox.

eventsEventType[] required
activeboolean required
failuresinteger required

Consecutive failures; disabled at 20.

last_seqinteger required

Last event delivered.

disabled_reasonstring nullable required
created_atstring date-time required
last_delivery_atstring date-time nullable required
secretstring required

whsec_…. Shown only once.

Changes

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