Skip to main content

Postmarkapp

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable PyAirbyte
Connector type
Available Data replicationNot available Agent(learn more)
Support Level
Marketplace
Connector Version
0.2.11 (last updated 2 days ago)
Sync Success Rate
Low
Usage Rate
Low
Data workers used
0.2 per sync (Learn more)
Definition ID
cde75ca1-1e28-4a0f-85bb-90c546de9f1f

Overview​

The Postmarkapp source syncs data from the Postmark API. It reads delivery statistics, message streams, outbound messages, and bounces for one Postmark server, plus the domains and servers in your Postmark account.

Prerequisites​

The connector requires two Postmark API tokens. Both are required, because some streams use server-level endpoints and others use account-level endpoints.

  • Server API token (X-Postmark-Server-Token): In Postmark, open the server you want to sync and go to the API Tokens tab. The server-level streams read data for this server only.
  • Account API token (X-Postmark-Account-Token): In Postmark, go to the API Tokens tab of your account. Only the account owner can access this token.

For details, see Postmark API authentication.

Setup guide​

  1. In Airbyte, go to Sources and click New source.
  2. Select Postmarkapp from the list of sources.
  3. Enter a name for the source.
  4. In X-Postmark-Server-Token, enter your server API token.
  5. In X-Postmark-Account-Token, enter your account API token.
  6. Click Set up source. Airbyte tests the connection by reading the message-streams stream.

Supported streams​

StreamPostmark endpointToken usedPrimary key
deliverystatsGet delivery statsServerName
message-streamsList message streamsServerID
messagesOutbound message searchServerMessageID
bouncesGet bouncesServerID
domainsList domainsAccountID
serversList serversAccountID

The deliverystats stream returns one record per bounce type, with the count of bounces of that type for the server.

Supported sync modes​

FeatureSupported?
Full Refresh SyncYes
Incremental SyncNo
NamespacesNo

Limitations​

  • Message retention: Postmark keeps outbound messages and bounces only for your server's retention period, which is 45 days by default and configurable from 7 to 365 days. The messages and bounces streams can't return records older than that.
  • 10,000-record search limit: The Postmark outbound message search and bounce search endpoints return at most 10,000 records per search. The connector doesn't filter these searches by date, so if a server has more than 10,000 retained messages or bounces, the messages and bounces streams can't read all of them.
  • Pagination: The connector requests 500 records per page, the maximum Postmark allows.

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

Field
Type
Property name
string
X-Postmark-Account-Token
string
X-Postmark-Server-Token

Changelog​

Expand to review
VersionDatePull RequestSubject
0.2.112026-11-1391434Upgrade to source-declarative-manifest 7.47.0 and fix offset pagination so every stream starts at the first record and stops on a short page
0.2.102025-02-1553947Update dependencies
0.2.92025-02-0853462Update dependencies
0.2.82025-02-0152967Update dependencies
0.2.72025-01-2551879Update dependencies
0.2.62025-01-1151372Update dependencies
0.2.52024-12-2850703Update dependencies
0.2.42024-12-2150281Update dependencies
0.2.32024-12-1449667Update dependencies
0.2.22024-12-1249046Update dependencies
0.2.12024-10-2847539Update dependencies
0.2.02024-10-0646522Migrate to Manifest-only
0.1.212024-10-0546509Update dependencies
0.1.202024-09-2845793Update dependencies
0.1.192024-09-1445535Update dependencies
0.1.182024-09-0745259Update dependencies
0.1.172024-08-3144975Update dependencies
0.1.162024-08-2444705Update dependencies
0.1.152024-08-1744309Update dependencies
0.1.142024-08-1043592Update dependencies
0.1.132024-08-0343265Update dependencies
0.1.122024-07-2742648Update dependencies
0.1.112024-07-2042190Update dependencies
0.1.102024-07-1341820Update dependencies
0.1.92024-07-1041564Update dependencies
0.1.82024-07-0941184Update dependencies
0.1.72024-07-0640762Update dependencies
0.1.62024-06-2540483Update dependencies
0.1.52024-06-2239970Update dependencies
0.1.42024-06-0439062[autopull] Upgrade base image to v1.2.1
0.1.32024-04-1937232Upgrade to CDK 0.80.0 and manage dependencies with Poetry.
0.1.22024-04-1537232Base image migration: remove Dockerfile and use the python-connector-base image
0.1.12024-04-1237232schema descriptions
0.1.02022-11-0918220🎉 New Source: Postmarkapp API [low-code CDK]
Was this page helpful?