Buttondown logo

Listing webhooks

Use the /webhooks endpoint to list all of your webhooks. Webhooks let you be notified when certain events happen in your newsletter, making it easy to build custom integrations and automations.

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"
}

response = requests.request("GET", url, headers=headers)
print(response.text)

Sample responses

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

{
    "results": [
        {
            "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": ""
        }
    ],
    "count": 1
}

Path parameters

Consult the Filtering documentation for more information on how to filter and sort your requests.

status

Type
WebhookStatus
Description

If provided, only return webhooks with the given status.

page

Type
string
Description

The page number of the paginated response.