Skip to main content

Postmark Connector

Postmark Send transactional emails and manage delivery settings in Postmark.

Connections

Postmark Token Authentication

Authenticate requests to Postmark using values obtained from the developer console.

To authenticate with Postmark, access tokens are required. Postmark provides two types of tokens: a Server Token for sending emails and server-related actions, and an Account Token for account-level management such as creating and managing servers.

Prerequisites

  • An active Postmark account
  • At least one server created in Postmark (required for Server Token)

Setup Steps

To generate access tokens:

  1. Log in to Postmark
  2. Navigate to Servers in the left sidebar
  3. Select the server to generate tokens for (or create a new server if needed)
  4. Click on the API Tokens tab in the server settings
  5. Locate the Server API Token in the API Tokens section
  6. Copy the Server Token value
  7. To obtain the Account Token, click on Account in the top navigation
  8. Select API Tokens from the account menu
  9. Copy the Account Token value

Configure the Connection

  • Enter the Account Token value into the Account Token field
  • Enter the Server Token value into the Server Token field

The Server Token is required for email sending operations and server-level actions. The Account Token is required for account-level operations such as creating and managing servers.

InputCommentsDefault
Account TokenAccount level API token from the Postmark API Tokens page. Used for account management operations like creating servers.
Server TokenServer level API token from your Postmark server settings. Used for sending emails and managing server-specific resources. Find it under Servers > [Your Server] > API Tokens.

Triggers

Webhook

Receive and validate webhook requests from Postmark for webhooks you configure.

Actions

Create Server

Create a new server

InputCommentsDefault
ConnectionThe Postmark connection to use.
Server NameFilter by a specific server name. Note: This is a partial match search - 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.
Server ColorColor label for the server in the Postmark interface.
SMTP API ActivatedWhen true, SMTP is enabled on this server.false
Raw Email EnabledWhen true, raw email content will be included with inbound webhook payloads under the RawEmail key.false
Delivery TypeThe type of environment for your server. Options: Live, Sandbox. Defaults to Live. Important: This cannot be changed after the server is created.Live
Inbound Hook URLThe URL to POST to whenever an inbound email event occurs.

Create Webhook

Create a new webhook

InputCommentsDefault
ConnectionThe Postmark connection to use.
Webhook URLThe URL where webhook events will be sent.
TriggersA JSON object specifying the triggers for the webhook. Use the default structure as a guideline.
{
"Open": {
"Enabled": true,
"PostFirstOpenOnly": false
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": false,
"IncludeContent": false
},
"SpamComplaint": {
"Enabled": false,
"IncludeContent": false
},
"SubscriptionChange": {
"Enabled": false
}
}

Delete Instanced Webhooks

Delete all webhooks that point to this instance

InputCommentsDefault
ConnectionThe Postmark connection to use.

Delete Server

Delete an existing server

InputCommentsDefault
ConnectionThe Postmark connection to use.
Server IDThe unique numeric identifier of the server.

Delete Webhook

Delete a specific webhook

InputCommentsDefault
ConnectionThe Postmark connection to use.
Webhook IDThe unique numeric identifier of the webhook.

Edit Server

Edit an existing server

InputCommentsDefault
ConnectionThe Postmark connection to use.
Server IDThe unique numeric identifier of the server.
Server NameFilter by a specific server name. Note: This is a partial match search - 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.
Server ColorColor label for the server in the Postmark interface.
SMTP API ActivatedWhen true, SMTP is enabled on this server.false
Raw Email EnabledWhen true, raw email content will be included with inbound webhook payloads under the RawEmail key.false
Inbound Hook URLThe URL to POST to whenever an inbound email event occurs.
Enable SMTP API Error HooksWhen true, SMTP API errors will be included with bounce webhooks.false

Edit Server Using Server Token Account

Edit an existing server

InputCommentsDefault
ConnectionThe Postmark connection to use.
Server NameFilter by a specific server name. Note: This is a partial match search - 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.
Server ColorColor label for the server in the Postmark interface.

Edit Webhook

Edit an existing webhook

InputCommentsDefault
ConnectionThe Postmark connection to use.
Webhook IDThe unique numeric identifier of the webhook.
Webhook URLThe URL where webhook events will be sent.
TriggersA JSON object specifying the triggers for the webhook. Use the default structure as a guideline.
{
"Open": {
"Enabled": true,
"PostFirstOpenOnly": false
},
"Click": {
"Enabled": true
},
"Delivery": {
"Enabled": true
},
"Bounce": {
"Enabled": false,
"IncludeContent": false
},
"SpamComplaint": {
"Enabled": false,
"IncludeContent": false
},
"SubscriptionChange": {
"Enabled": false
}
}

Get Server

Get an existing server by ID

InputCommentsDefault
Server IDThe unique numeric identifier of the server.
ConnectionThe Postmark connection to use.

Get Server

Get server information

InputCommentsDefault
ConnectionThe Postmark connection to use.

Get Webhook

Retrieve a specific webhook

InputCommentsDefault
ConnectionThe Postmark connection to use.
Webhook IDThe unique numeric identifier of the webhook.

List Servers

Get a list of all servers associated with the account

InputCommentsDefault
ConnectionThe Postmark connection to use.
CountNumber of servers to return per request. Maximum 500.
OffsetNumber of servers to skip for pagination.
Server NameFilter by a specific server name. Note: This is a partial match search - 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.

List Webhooks

List all webhooks for a server

InputCommentsDefault
ConnectionThe Postmark connection to use.
Show Only Instance WebhooksWhen true, show only webhooks that point to this instance.true

Raw Request

Send raw HTTP request to Postmark

InputCommentsDefault
ConnectionThe Postmark connection to use.
URLInput the path only (/servers/9363760), The base URL is already included (https://api.postmarkapp.com). For example, to connect to https://api.postmarkapp.com/servers/9363760, only /servers/9363760 is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Debug RequestEnabling this flag will log out the current request.false
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Send Email

Send an email using Postmark

InputCommentsDefault
ConnectionThe Postmark connection to use.
From AddressThe sender email address. Must be a verified sender signature in Postmark.
To AddressThe recipient email address(es). Multiple addresses can be comma-separated. Maximum of 50 recipients per message.
CcCarbon copy recipient email address(es). Multiple addresses can be comma-separated. Maximum of 50 recipients per message.
BccBlind carbon copy recipient email address(es). Multiple addresses can be comma-separated. Maximum of 50 recipients per message.
SubjectThe subject line of the email message.
TagA tag to categorize the email for tracking and filtering purposes.
Html BodyThe HTML content of the email message.
Text BodyThe plain text content of the email message.
Reply ToReply-to email address override. Defaults to the Reply To address set in the sender signature.
Track OpensWhen true, activate open tracking for this email.true
HeadersList of custom headers to include.
MetadataCustom metadata key/value pairs.
AttachmentsList of attachments

Send Email Batch

Send a batch of emails using Postmark

InputCommentsDefault
ConnectionThe Postmark connection to use.
EmailsProvide a JSON array of email objects. Each object should include the necessary email information.
[
{
"fromAddress": "test@example.com",
"toAddress": "user@example.com",
"ccAddress": "cc@example.com",
"bccAddress": "bcc@example.com",
"subject": "Hello, world!",
"tag": "tag-example",
"htmlBody": "

Hello, world!

",
"textBody": "Hello, world!",
"replyTo": "reply@example.com",
"headers": [
{
"Name": "CUSTOM-HEADER",
"Value": "value"
}
],
"metadata": {
"color": "green",
"client-id": "12345"
},
"attachments": [
{
"Name": "readme.txt",
"Content": "dGVzdCBjb250ZW50",
"ContentType": "text/plain"
},
{
"Name": "report.pdf",
"Content": "dGVzdCBjb250ZW50",
"ContentType": "application/octet-stream"
}
]
},
{}
]

Send Email Batch With Template

Send a batch of emails using a Postmark template

InputCommentsDefault
ConnectionThe Postmark connection to use.
MessagesThe list of templates to send. Please note that we accept up to 500 messages per API call.
{
"Messages": [
{
"From": "sender@example.com",
"To": "receiver@example.com",
"TemplateId": 31941508,
"TemplateModel": {
"fizz": "buzz"
}
},
{
"From": "sender@example.com",
"To": "receiver@example.com",
"TemplateAlias": "code-your-own",
"TemplateModel": {
"fizz": "buzz"
}
}
]
}

Send Email With Template

Send an email with a Postmark template

InputCommentsDefault
ConnectionThe Postmark connection to use.
From AddressThe sender email address. Must be a verified sender signature in Postmark.
To AddressThe recipient email address(es). Multiple addresses can be comma-separated. Maximum of 50 recipients per message.
CcCarbon copy recipient email address(es). Multiple addresses can be comma-separated. Maximum of 50 recipients per message.
BccBlind carbon copy recipient email address(es). Multiple addresses can be comma-separated. Maximum of 50 recipients per message.
SubjectThe subject line of the email message.
TagA tag to categorize the email for tracking and filtering purposes.
Html BodyThe HTML content of the email message.
Text BodyThe plain text content of the email message.
Reply ToReply-to email address override. Defaults to the Reply To address set in the sender signature.
Track OpensWhen true, activate open tracking for this email.true
HeadersList of custom headers to include.
MetadataCustom metadata key/value pairs.
AttachmentsList of attachments
Template IDThe numeric ID of the Postmark template to use for sending the email.
Template ModelThe template data to use with the email template
{
"fizz": "buzz",
"test": "case"
}
Template AliasThe alias of a template to use when sending this message. Required if Template ID is not specified.
Inline CssWhen true, CSS style blocks in the template will be applied as inline attributes to the rendered HTML content.true