Buttondown Documentation
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:
Represents an incoming request that was blocked by the firewall.
Whenever a subscriber's email is successfully delivered.
Whenever a subscriber's email is bounced.
Whenever a subscriber has complained about one of your emails.
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 a new subscriber is created.
When a subscriber has manually unsubscribed from your newsletter.
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.)
When the trial has started for a subscriber. (For newsletters with automatic free trials, this will be created immediately after subscriber.confirmed.)
When the trial has ended for a subscriber.
When a subscriber has enrolled in your newsletter's paid offering.
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's notes or metadata has changed.
When a subscriber's email address has been changed.
When a subscriber's type has been changed.
When a subscriber's tags have been modified.
When a subscriber has opened one of your emails.
When a subscriber has been deleted from your newsletter.
When a subscriber has viewed your checkout page.
When a subscriber has paused their subscription.
When a subscriber has resumed their subscription after pausing it.
When a subscriber has responded to a survey in your newsletter.
When a subscriber has referred someone to your newsletter.
When a subscriber's referral has converted to a paid subscription.
When a subscriber has commented on one of your emails.
Whenever a new survey is created.
Whenever a survey's content or metadata has been updated.
Whenever a survey has been deleted.
Whenever a survey's responses have been cleared.
Whenever a new email is created and begins delivery. Note that event happens immediately before the emails themselves are sent.
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 has been deleted.
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 an export is created.
Whenever an export is completed.
Whenever an export fails.
Whenever a new item is created in an RSS feed.
Whenever a new customer is created in Shopify.
Whenever a customer changes their email address in Shopify.
Whenever a new membership is created in Patreon.
Whenever a membership is deleted in Patreon.
Whenever a member changes their email address in Patreon.
Whenever a note is created.
Whenever a note is deleted.
Whenever a new subscription is created in Memberful.
Whenever a subscription is deleted in Memberful.
Whenever a member changes their email address in Memberful.
Whenever a subscription is activated in Stripe.
Whenever a subscription is churning in Stripe.
Whenever a subscription is deactivated in Stripe.
Whenever a customer changes their email address in Stripe.
Whenever a Stripe checkout session is completed successfully.
Whenever your newsletter is mentioned elsewhere.
Whenever an automation is manually invoked (e.g. by a webhook or API call).
Whenever an advertising slot in your newsletter is purchased.
Whenever your newsletter is mentioned on another website such as Reddit, Twitter, Bluesky, etc.
Whenever a new day starts. This event is fired at midnight UTC.
Whenever a new week starts. This event is fired at midnight UTC on Monday.
Whenever a new month starts. This event is fired at midnight UTC on the first day of each month.
Whenever a new year starts. This event is fired at midnight UTC on January 1st.