Skip to main content

Postmark Connector

Postmark The Postmark component is used as a developer friendly email delivery service

Connections

Postmark Token Authentication

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

InputCommentsDefault
Account Token
Server Token

Triggers

Webhook

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

Actions

Create Server

Create a new server

InputCommentsDefault
ConnectionThe connection to use
Server NameFilter by a specific server name. Note that this is a string search, so 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.
Server Color
SMTP API ActivatedSpecifies whether or not SMTP is enabled on this server.false
Raw Email EnabledWhen enabled, the raw email content will be included with inbound webhook payloads under the RawEmail key.false
Delivery TypeSpecifies the type of environment for your server. Possible options: Live, Sandbox. Defaults to Live if not specified. This cannot be changed after the server has been created.Live
Inbound Hook URLURL to POST to every time an inbound event occurs.

Create Webhook

Create a new webhook

InputCommentsDefault
ConnectionThe connection to use
Webhook URLYour webhook URL.
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 connection to use

Delete Server

Delete an existing server

InputCommentsDefault
ConnectionThe connection to use
Server ID

Delete Webhook

Delete a specific webhook

InputCommentsDefault
ConnectionThe connection to use
Webhook IDThe ID of the webhook to retrieve.

Edit Server

Edit an existing server

InputCommentsDefault
ConnectionThe connection to use
Server ID
Server NameFilter by a specific server name. Note that this is a string search, so 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.
Server Color
SMTP API ActivatedSpecifies whether or not SMTP is enabled on this server.false
Raw Email EnabledWhen enabled, the raw email content will be included with inbound webhook payloads under the RawEmail key.false
Inbound Hook URLURL to POST to every time an inbound event occurs.
Enable SMTP API Error Hooksfalse

Edit Server Using Server Token Account

Edit an existing server

InputCommentsDefault
ConnectionThe connection to use
Server NameFilter by a specific server name. Note that this is a string search, so 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.
Server Color

Edit Webhook

Edit an existing webhook

InputCommentsDefault
ConnectionThe connection to use
Webhook IDThe ID of the webhook to retrieve.
Webhook URLYour webhook URL.
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 ID
ConnectionThe connection to use

Get Server

Get server information

InputCommentsDefault
ConnectionThe connection to use

Get Webhook

Retrieve a specific webhook

InputCommentsDefault
ConnectionThe connection to use
Webhook IDThe ID of the webhook to retrieve.

List Servers

Get a list of all servers associated with the account

InputCommentsDefault
ConnectionThe connection to use
CountNumber of servers to return per request
OffsetNumber of servers to skip
Server NameFilter by a specific server name. Note that this is a string search, so 'MyServer' will match 'MyServer', 'MyServer Production', and 'MyServer Test'.

List Webhooks

List all webhooks for a server

InputCommentsDefault
ConnectionThe connection to use
Show Only Instance WebhooksShow only webhooks that point to this instance.true

Raw Request

Send raw HTTP request to Postmark

InputCommentsDefault
ConnectionThe 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 connection to use
From AddressProvide a string value for the sender email address.
To AddressProvide a string value for the recipient(s) email address. Can pass multiple as comma separated. Maximum of 50 recipients per message
CcProvide a string value for any carbon copied email address(es). Can pass multiple as comma separated. Maximum of 50 recipients per message
BccProvide a string value for any blind carbon copied email address(es). Can pass multiple as comma separated. Maximum of 50 recipients per message
SubjectProvide string value for the subject of the outgoing message
TagProvide a string to categorize outgoing message
Html BodyProvide specified HTML email message
Text BodyProvide a string for the body of the outgoing message
Reply ToReply To override email address. Defaults to the Reply To set in the sender signature.
Track OpensActivate 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 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 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 connection to use
From AddressProvide a string value for the sender email address.
To AddressProvide a string value for the recipient(s) email address. Can pass multiple as comma separated. Maximum of 50 recipients per message
CcProvide a string value for any carbon copied email address(es). Can pass multiple as comma separated. Maximum of 50 recipients per message
BccProvide a string value for any blind carbon copied email address(es). Can pass multiple as comma separated. Maximum of 50 recipients per message
SubjectProvide string value for the subject of the outgoing message
TagProvide a string to categorize outgoing message
Html BodyProvide specified HTML email message
Text BodyProvide a string for the body of the outgoing message
Reply ToReply To override email address. Defaults to the Reply To set in the sender signature.
Track OpensActivate open tracking for this email.true
HeadersList of custom headers to include.
MetadataCustom metadata key/value pairs.
AttachmentsList of attachments
Template IDID of the template to use to send 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 TemplateId is not specified.
Inline CssBy default, if the specified template contains an HTMLBody, we will apply the style blocks as inline attributes to the rendered HTML content. You may opt-out of this behavior by passing false for this request field.true