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!)
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.
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 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 deactivated in Stripe.
Whenever a customer changes their email address in Stripe.
Whenever an automation is manually invoked (e.g. by a webhook or API call).