webhooks

Update a webhook

Scope: manage. Setting active: true re-enables a disabled webhook and resets failures.

patch/v1/webhooks/{id}

Request

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

Request body

activeboolean
eventsEventType[]

Response

The updated webhook.

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

Changes

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