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.
The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.
All parameters are optional unless explicitly specified.
Whether the webhook is enabled or not.
[
"enabled"
]The webhook is enabled and will receive events.
The webhook is disabled and will not receive events.
The types of event for which the webhook will be triggered.
[
[
"email.created",
"email.sent"
]
]Whenever a sponsor submits an inquiry for an advertising slot.
Whenever an advertising slot in your newsletter is purchased.
Whenever an automation is manually invoked (e.g. by a webhook or API call).
Whenever a new day starts. This event is fired at midnight UTC.
Whenever a new month starts. This event is fired at midnight UTC on the first day of each month.
Whenever a new week starts. This event is fired at midnight UTC on Monday.
Whenever a new year starts. This event is fired at midnight UTC on January 1st.
Whenever a new customer is synced from BigCommerce.
Whenever a customer's data is updated in BigCommerce.
Whenever a new order is synced from BigCommerce.
Whenever an order's data is updated in BigCommerce.
Whenever a new email is created and begins delivery. Note that event happens immediately before the emails themselves are sent.
Whenever an email has been deleted.
Whenever an email starts sending. This fires as soon as the send is underway, before any recipient has been delivered to — useful for cross-posting, which otherwise waits for the whole send to finish.
Whenever an email has finished its delivery. Note that event happens immediately after all emails have been sent, but some email events may not have finished processing.
Whenever an email's status has changed (e.g. from 'draft' to 'sent'.) The metadata field will contain the previous and new statii in 'old_value' and 'new_value' respectively.
Whenever an email's content or metadata has been updated.
Whenever a new item is created in an RSS feed.
Whenever an export is completed.
Whenever an export is created.
Whenever an export fails.
Represents an incoming request that was blocked by the firewall.
Whenever your newsletter is mentioned elsewhere.
Whenever a member changes their email address in Memberful.
Whenever a new subscription is created in Memberful.
Whenever a subscription is deleted in Memberful.
Whenever a note is created.
Whenever a note is deleted.
Whenever a member changes their email address in Patreon.
Whenever a new membership is created in Patreon.
Whenever a membership is deleted in Patreon.
Whenever a new customer is created in Shopify.
Whenever a customer changes their email address in Shopify.
Whenever a Stripe checkout session is completed successfully.
Whenever a customer changes their email address in Stripe.
When a paid subscriber's subscription is approaching its renewal date, mapped from Stripe's invoice.upcoming webhook. Lets you message subscribers before they're charged again.
Whenever a subscription is activated in Stripe.
Whenever a subscription is churning in Stripe.
Whenever a subscription is deactivated in Stripe.
When a subscriber's confirmation (opt-in) email bounced.
When a subscriber clicked a link in their confirmation (opt-in) email.
When a subscriber marked their confirmation (opt-in) email as spam.
When a subscriber's confirmation (opt-in) email was deferred (a transient delivery failure the provider will retry).
When a subscriber's confirmation (opt-in) email was successfully delivered.
When a subscriber opened their confirmation (opt-in) email.
When a subscriber's confirmation (opt-in) email was rejected (a permanent delivery failure).
Whenever a subscriber's email is bounced.
When a subscriber's email address has been changed.
When a subscriber has unenrolled from your newsletter's paid offering.
When a subscriber has clicked a link in one of your emails.
When a subscriber has commented on one of your emails.
Whenever a subscriber has complained about one of your emails.
When a subscriber has confirmed that they are enrolled in your newsletter. (For newsletters without double opt-in, this event is created immediately after subscriber.created.)
Whenever a new subscriber is created.
When a subscriber's email was deferred (a transient delivery failure the email provider will retry).
When a subscriber has been deleted from your newsletter.
Whenever a subscriber's email is successfully delivered.
When a subscriber has opened one of your emails.
When a subscriber has enrolled in your newsletter's paid offering.
When a subscriber has paused their subscription.
When a subscriber has resumed their subscription after pausing it.
When a subscriber has referred someone to your newsletter.
When a subscriber's referral has converted to a paid subscription.
Whenever a subscriber (or their email provider) has rejected an email from your newsletter. Buttondown takes rejections seriously, and will likely block the subscriber's email address from future emails and/or mark them as undeliverable.
Whenever a subscriber has replied to one of your emails.
Whenever an email has been sent to a subscriber.
When a subscriber has responded to a survey in your newsletter.
When the trial has ended for a subscriber.
When the trial has started for a subscriber. (For newsletters with automatic free trials, this will be created immediately after subscriber.confirmed.)
When a subscriber's type has been changed.
When a subscriber has manually unsubscribed from your newsletter.
When a subscriber's notes or metadata has changed.
When a subscriber has viewed your checkout page.
Whenever a survey's responses have been cleared.
Whenever a new survey is created.
Whenever a survey has been deleted.
Whenever a survey's content or metadata has been updated.
Whenever a new form is created.
Whenever a form has been deleted.
Whenever a form's content or metadata has been updated.
The URL to which the webhook will send POST requests.
[
"https://my.api/webhook"
]An optional description of the webhook, for reference.
[
"Trigger when an email is created to notify in Slack."
]Optional HMAC signing key for webhook verification. When set, webhook requests will include an X-Buttondown-Signature header with sha256=
[
""
]