Linking BigMailer as a source
This source is currently in alpha. The interface and available tables may change.
The BigMailer connector syncs your email marketing data into the PostHog Data warehouse, so you can analyze your campaigns and contacts alongside your product data.
Prerequisites
You need a BigMailer account with API access so you can create an API key. The key has account-wide access, so no extra scopes need to be granted.
Adding a data source
- In PostHog, go to the Sources tab of the data pipeline section.
- Click + New source and click Link next to this source.
- Enter your credentials (see Configuration below) and click Next.
- Select the tables you want to sync, choose a sync method and frequency, then click Import.
Once the syncs are complete, you can start querying this data in PostHog.
When linking BigMailer, you'll need:
- API key – create one in your BigMailer console under Account Settings → API Keys.
Sync modes
Each table can be synced in one of several modes, depending on what the source supports:
- Webhook (when available) – the source pushes changes to PostHog in real time. Fastest freshness, lowest ongoing cost, and the only mode that reliably captures updates and deletes.
- Incremental – only new or updated rows are synced on each run, using a cursor field (such as an
updated_attimestamp). Cheaper than a full refresh, but deletes aren't captured. - Append only – new rows are appended using a cursor field; existing rows are never updated. Ideal for immutable, append-only tables like event logs.
- Full refresh – the whole table is reloaded on every sync. Use it when a table has no reliable cursor or when you need deletions reflected.
See sync methods for a full explanation of how each mode works and how to choose between them.
All BigMailer tables are full refresh only, since the API exposes no incremental sync filter.
Configuration
| Option | Type | Required |
|---|---|---|
API key | password | Yes |
Supported tables
| Table | Description | Sync method | Incremental field | Primary key |
|---|---|---|---|---|
brands | Brands in your BigMailer account. A brand groups its own contacts, lists, campaigns and senders. | Full refresh | — | — |
users | Users (team members) with access to your BigMailer account. | Full refresh | — | — |
contacts | Contacts (subscribers) in a brand, with their field values, list memberships and bounce/complaint counts. | Full refresh | — | — |
lists | Contact lists in a brand. Campaigns are sent to one or more lists. | Full refresh | — | — |
segments | Segments in a brand: saved filters over contacts defined by a set of conditions. | Full refresh | — | — |
fields | Custom fields in a brand, used for personalization merge tags and segmentation. | Full refresh | — | — |
bulk_campaigns | Bulk (one-off) email campaigns in a brand, with their configuration and aggregate send metrics. | Full refresh | — | — |
transactional_campaigns | Transactional email campaigns in a brand, triggered per-recipient via the API, with aggregate metrics. | Full refresh | — | — |
rss_campaigns | RSS-driven email campaigns in a brand, which send on a schedule from a feed URL. | Full refresh | — | — |
message_types | Message types in a brand, the subscription categories contacts can opt out of independently. | Full refresh | — | — |
senders | Sender identities (from-addresses and bounce domains) configured for a brand. | Full refresh | — | — |
templates | Reusable email templates in a brand. | Full refresh | — | — |
suppression_lists | Campaign suppression lists uploaded to a brand, used to exclude addresses from sends. | Full refresh | — | — |
Troubleshooting
- If the connection fails, your BigMailer API key is invalid or lacks the required permissions. Create a new key in your BigMailer console, then reconnect.
If your sync is failing or data looks wrong, see the Data warehouse troubleshooting guide. If that doesn't help, contact support – we're happy to help.