Sign in
Webhooks

Update Webhook

Update a webhook's properties

patch/webhooks/{id}

Path parameters

idstring required

Request body

status'enabled' | 'disabled'

The status of a webhook.

event_typesExternalEventType[] required

The types of event for which the webhook will be triggered.

urlstring uri required

The URL to which the webhook will send POST requests.

descriptionstring

An optional description of the webhook, for reference.

signing_keystring

Optional HMAC signing key for webhook verification. When set, webhook requests will include an X-Buttondown-Signature header with sha256=<signature>.

Example request

{
  "event_types": [
    [
      "email.created",
      "email.sent"
    ]
  ]
}

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

status'enabled' | 'disabled' required

The status of a webhook.

event_typesExternalEventType[] required

The types of event for which the webhook will be triggered.

urlstring required

The URL to which the webhook will send POST requests.

descriptionstring

An optional description of the webhook, for reference.

signing_keystring

Optional HMAC signing key for webhook verification. When set, webhook requests will include an X-Buttondown-Signature header with sha256=<signature>.

Changes