From 5a18f22b11bf55641cf62ee0f0858f6ea1df5557 Mon Sep 17 00:00:00 2001 From: Julien Coulaud Date: Wed, 29 Jul 2026 21:39:29 +0100 Subject: [PATCH] docs: add Shipmail warehouse source --- contents/docs/cdp/sources/shipmail.md | 59 +++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 contents/docs/cdp/sources/shipmail.md diff --git a/contents/docs/cdp/sources/shipmail.md b/contents/docs/cdp/sources/shipmail.md new file mode 100644 index 000000000000..2ee60cce0098 --- /dev/null +++ b/contents/docs/cdp/sources/shipmail.md @@ -0,0 +1,59 @@ +--- +title: Linking Shipmail as a source +sidebar: Docs +showTitle: true +availability: + free: full + selfServe: full + enterprise: full +sourceId: Shipmail +--- + +import SourceSetupIntro from "../_snippets/source-setup-intro.mdx" +import SyncModes from "../_snippets/sync-modes.mdx" +import TroubleshootingLink from "../_snippets/dw-troubleshooting-link.mdx" +import AlphaRelease from "../_snippets/alpha-release.mdx" + + + +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 + + + +When linking Shipmail, create an **API key** in your [Shipmail API settings](https://shipmail.to/settings/api-keys) and grant it the required read scopes. + +## Sync modes + + + +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 + + + +## 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. + + + +## 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. + +