Buttondown Documentation

Buttondown Documentation

© 2016–2024 Buttondown LLC.

TwitterDiscord GitHubLinkedInMastodonBlueskyFacebook

Event types

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!)

subscriber.replied

Type
subscriber.replied
Description
Whenever a subscriber has replied to one of your emails.

subscriber.created

Type
subscriber.created
Description
Whenever a new subscriber is created.

subscriber.unsubscribed

Type
subscriber.unsubscribed
Description
When a subscriber has manually unsubscribed from your newsletter.

subscriber.confirmed

Type
subscriber.confirmed
Description
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`.)

subscriber.trial_started

Type
subscriber.trial_started
Description
When the trial has started for a subscriber. (For newsletters with automatic free trials, this will be created immediately after `subscriber.confirmed`.)

subscriber.trial_ended

Type
subscriber.trial_ended
Description
When the trial has ended for a subscriber.

subscriber.paid

Type
subscriber.paid
Description
When a subscriber has enrolled in your newsletter's paid offering.

subscriber.churned

Type
subscriber.churned
Description
When a subscriber has unenrolled from your newsletter's paid offering.

subscriber.clicked

Type
subscriber.clicked
Description
When a subscriber has clicked a link in one of your emails.

subscriber.updated

Type
subscriber.updated
Description
When a subscriber's notes or metadata has changed.

email.created

Type
email.created
Description
Whenever a new email is created and begins delivery. Note that event happens immediately before the emails themselves are sent.

email.sent

Type
email.sent
Description
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.

email.deleted

Type
email.deleted
Description
Whenever an email has been deleted.

email.status.changed

Type
email.status.changed
Description
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.

memberful.subscription.created

Type
memberful.subscription.created
Description
Whenever a new subscription is created in Memberful.

memberful.subscription.deleted

Type
memberful.subscription.deleted
Description
Whenever a subscription is deleted in Memberful.

memberful.member.updated

Type
memberful.member.updated
Description
Whenever a member changes their email address in Memberful.

stripe.subscription.activated

Type
stripe.subscription.activated
Description
Whenever a subscription is activated in Stripe.

stripe.subscription.churning

Type
stripe.subscription.churning
Description
Whenever a subscription is churning in Stripe.

stripe.subscription.deactivated

Type
stripe.subscription.deactivated
Description
Whenever a subscription is deactivated in Stripe.

stripe.customer.updated

Type
stripe.customer.updated
Description
Whenever a customer changes their email address in Stripe.

automation.invoked

Type
automation.invoked
Description
Whenever an automation is manually invoked (e.g. by a webhook or API call).

social_mention.created

Type
social_mention.created
Description
Whenever your newsletter is mentioned on another website such as Reddit, Twitter, Bluesky, etc.

Referenced by

Types of automation triggersCan I send a specific email to my new subscribers?Events and webhooks

© 2016–2024 Buttondown LLC.

TwitterDiscord GitHubLinkedInMastodonBlueskyFacebook