Buttondown Documentation

Buttondown Documentation

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook

Testing a webhook

When called, this endpoint sends a webhook request with fake information to test that it works.

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/webhooks/{id}/test"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("POST", 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.

{}

Path parameters

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

event_type

Type
string
Description

Various types of events that are recorded by Buttondown, both in terms of exogenous systems like Stripe and Memberful, and endogenous ones like email opens and clicks. (In general, if anything important ever happens that could be relevant to your newsletter, we have an event type for it!)

These event types power lots of things within Buttondown. They're used to trigger automations, webhooks, and analytics.

(Note that Buttondown also has a different thing we call "events"; those are EmailEvents and are used for tracking aggregate details about an email. Alas, we shouldn't have used the term "event" for two different things, but it's too late to go back now!)

In general, our event namespacing tries to hew to the following pattern:

..

When wondering which object we are referring to, default to the more granular object.

For instance, an email being sent to a subscriber is subscriber.delivered, not email.sent.

© 2016–2025 Buttondown LLC.

TwitterGitHubLinkedInMastodonBlueskyFacebook