BUbuttondown
Webhooks

Create Webhook

Changed on

Create a new webhook

post/webhooks

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/webhooks
  • Auth
    API key in header Authorization

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

Created

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

  • 9d2fc1dfd458Revision changes
    • warning

      added the new stripe.charge.succeeded enum value to the / response property for the response status

    • info

      added the new stripe.charge.succeeded enum value to the request property /

  • 0d89acd77e2eRevision changes
    • warning

      added the new subscriber.dropped_from_import enum value to the / response property for the response status

    • warning

      added the new subscriber.imported enum value to the / response property for the response status

    • info

      added the new subscriber.dropped_from_import enum value to the request property /

    • info

      added the new subscriber.imported enum value to the request property /