Buttondown logo

Creating a webhook

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/webhooks"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}
data = {
  "status": "enabled",
  "event_types": [
    "email.created",
    "email.sent"
  ],
  "url": "https://my.api/webhook",
  "description": "Trigger when an email is created to notify in Slack."
}

response = requests.request("POST", url, headers=headers, json=data)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
    "creation_date": "2020-09-29T00:00:00Z",
    "status": "enabled",
    "event_types": [
        "subscriber.created"
    ],
    "url": "https://example.com/webhook",
    "description": "",
    "signing_key": ""
}

Body parameters

All parameters are optional unless explicitly specified.

status

Type
WebhookStatus
Description

Whether the webhook is enabled or not.

Example
"enabled"

event_types

Type
ExternalEventType[] · required
Description

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

Example
[ "email.created", "email.sent" ]

url

Type
string · required
Description

The URL to which the webhook will send POST requests.

Example
"https://my.api/webhook"

description

Type
Description

An optional description of the webhook, for reference.

Example
"Trigger when an email is created to notify in Slack."

signing_key

Type
Description

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