Documentation
Learn how to install, configure, and use Broadcast to send email campaigns, manage subscribers, and build automated sequences.
These docs follow your version of Broadcast. Pick it in the Broadcast version menu at the top of any page, and each page shows what applies to that version. Choose Upcoming (edge) to read about features in the next release before they ship.
Quick Start
Get up and running with Broadcast in four steps:
Browse by Category
Getting Started
Install and configure Broadcast on your Ubuntu server.
Using Broadcast
Manage subscribers, send campaigns, and automate your emails.
API Reference
Integrate Broadcast with your applications using our REST API.
Common Tasks
Glossary
Broadcast uses a few terms in a specific way. If you come from another email platform, this is how they map.
Channel. A channel holds a set of subscribers and the emails you send to them. Other platforms call this a “list”. See Channels.
Broadcast email. An email you write and send by hand, once, such as a newsletter, an alert, or a promotion. “Broadcast” is also the name of the software, so the docs say “broadcast email” when they mean the email. See Broadcast Emails.
Email sequence. A series of automated emails that go to a subscriber on a schedule or after a trigger event. Other platforms call this a “drip campaign”. See Email Sequences.
Transactional email. An email your application sends through the API when a user does something, such as a password reset, an order confirmation, or a shipping notice. See Transactional Emails.
Subscriber. A person in a channel who receives your emails. Subscribers join through an opt-in form, or you add or import them yourself. See Managing Subscribers.
Need Help?
Can’t find what you’re looking for? We’re here to help.
Answers organized by what you are trying to do, or by what has gone wrong, rather than by feature. Useful when you don’t yet know which page you need.
