Linking Shipmail as a source

Let AI connect your sources for you

Skip the manual setup — run this in your project and the wizard auto-detects your databases and APIs and connects them to PostHog.

Learn more

Alpha release

This source is currently in alpha. The interface and available tables may change.

The Shipmail connector syncs message analytics, mailboxes, domains, and suppressions into the PostHog Data warehouse, so you can analyze email activity alongside your product data.

Prerequisites

You need a Shipmail account and an API key. Grant the key the read scopes for the tables you want to sync:

messages:read for message analytics
mailboxes:read for mailboxes
domains:read for domains
suppressions:read for suppressions

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 Shipmail, create an API key in your Shipmail API settings and grant it the required read scopes.

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_at timestamp). 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.

The messages table supports incremental syncs using updated_at. Incremental sync is recommended because it captures new messages and status updates without reloading the full table.

The mailboxes, domains, and suppressions tables use full refresh because their API endpoints don't support filtering by update time.

Configuration

Option	Description
`API key` Type: password Required: True	Create a key in your Shipmail API settings.

Supported tables

The messages table contains an analytics-safe projection. It excludes message bodies, subjects, BCC addresses, headers, attachment filenames, and free-form metadata. The contact_addresses and client_reference fields can still contain personal data.

Table	Description	Sync method	Incremental field	Primary key
`messages`	Analytics-safe message records in stable update order, without message content or sensitive headers.	Incremental, Full refresh	updated_at	id
`mailboxes`	Mailboxes belonging to the authenticated Shipmail organization.	Full refresh	—	id
`domains`	Sending and receiving domains configured in the authenticated Shipmail organization.	Full refresh	—	id
`suppressions`	Email addresses suppressed from outbound delivery.	Full refresh	—	email_address

Troubleshooting

If you see an authentication error, your API key is invalid or has been revoked. Create a new key in Shipmail, then reconnect.
If a table is unavailable or returns a permission error, add its required read scope to the API key, then try the sync again.

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.