Overview
Integration
User guide
API reference
Webhooks
Introduction
Official libraries
- Rails gem
- Ruby gem
- .NET
- Java
- PHP
- Craft plugin
- Node.js
- CLI
- WordPress plugin
- Grunt plugin
- Zapier Actions
Community libraries
- Classic ASP
- Clojure
- ColdFusion
- Django
- Drupal module
- Elixir
- Erlang
- Google Go
- Grails plugin
- Haskell
- Java
- Laravel
- Magento extension
- Node.js
- Objective-C
- Perl
- Pharo Smalltalk
- PHP 5
- PowerShell Snap-in
- Python
- Scala
- Swift
- WordPress
- Zend
Tools and Integrations
Sending email with API
- Send a single email
- Send batch emails
Sending email with SMTP
Processing email
- Configure an inbound server
- Inbound domain forwarding
- Parse an email
- Configure inbound blocking
- Sample inbound workflow
Tracking opens
- Tracking opens per Server
- Tracking opens per email
- Message opens API
Tracking links
Managing your account
- Managing sender signatures
- Managing servers
Sandbox mode
- Server sandbox mode
- Generate fake bounces
Overview
- Endpoint URL
- Authentication
- HTTP response codes
- API error codes
Email
- Send a single email
- Send batch emails
Bulk
- Send bulk emails
- Get the status/details of a bulk API request
Bounce
- Get delivery stats
- Get bounces
- Get a single bounce
- Get bounce dump
- Activate a bounce
- Bounce types
- Rebound
Templates
- Send email with template
- Send batch with templates
- Push templates to another server
- Get a template
- Create a template
- Edit a template
- List templates
- Delete a template
- Validate a template
Server
- Get the server
- Edit the server
Servers
- Get a server
- Create a server
- Edit a server
- List servers
- Delete a server
Message Streams
- List message streams
- Get a message stream
- Edit a message stream
- Create a message stream
- Archive a message stream
- Unarchive a message stream
Messages
- Outbound message search
- Outbound message details
- Outbound message dump
- Inbound message search
- Inbound message details
- Bypass rules for a blocked inbound message
- Retry a failed inbound message for processing
- Message opens
- Opens for a single message
- Message clicks
- Clicks for a single message
Domains
- List domains
- Get domain details
- Create domain
- Edit domain
- Delete domain
- Verify DKIM
- Verify Return-Path
- Verify an SPF record
- Rotate DKIM keys
Sender signatures
- List sender signatures
- Get sender signature
- Create a signature
- Edit a signature
- Delete a signature
- Resend a confirmation
- Verify an SPF record
- Request a new DKIM
Stats
- Get outbound overview
- Get sent counts
- Get bounce counts
- Get spam complaints
- Get tracked email counts
- Get email open counts
- Get email platform usage
- Get email client usage
- Get click counts
- Get browser usage
- Get browser platform usage
- Get click location
Triggers: Inbound rules
- List inbound rule triggers
- Create an inbound rule trigger
- Delete a single trigger
Webhooks
- List webhooks
- Get a webhook
- Create a webhook
- Edit a webhook
- Delete a webhook
Suppressions
- Suppression dump
- Create a Suppression
- Delete a Suppression
Data Removal
- Create a Data Removal request
- Check a Data Removal request status
Webhooks overview
- What is a webhook?
- Protecting your webhook
- Testing your webhook
- Retry attempts
Bounce webhook
- What is a bounce webhook?
- Set the webhook URL
- Bounce webhook data
- Testing with curl
- How you can use the data
- Rebound
Inbound webhook
- What is an inbound webhook?
- Inbound webhook data
- Testing with curl
- How you can use the data
- Errors and retries
- Set the webhook URL
Open tracking webhook
- What is an open webhook?
- Set the webhook URL
- Open webhook data
- Testing with curl
- How you can use the data
Delivery webhook
- What is a delivery webhook?
- Set the webhook URL
- Delivery webhook data
- Testing with curl
- How you can use the data
Click webhook
- What is a click webhook?
- Set the webhook URL
- Click webhook data
- Testing with curl
- How you can use the data
Spam complaint webhook
- What is a spam complaint?
- Set the webhook URL
- Spam complaint webhook data
- Testing the spam complaint webhook with curl
- How you can use the data
Subscription change webhook
- What is a subscription change?
- Set the subscription change webhook URL
- Subscription change webhook data
- Testing the subscription change webhook with curl
- How you can use the subscription change data
SMTP API Error
- What is an SMTP API Error
- Set SMTP API Errors for a Server
- SMTP API Error Data
- Testing the SMTP API Error
- How can you use SMTP API Error
Inbound rules triggers API
Inbound rules triggers let you block messages from certain senders. You can block messages by email address or by domain.
List inbound rule triggers
Try →
#
get
/triggers/inboundrules
Request headers
Accept
required application/json
X-Postmark-Server-Token
required This request requires server level priveledges. This token can be found on the Credentials tab under your Postmark server.
Example request with curl
curl "https://api.postmarkapp.com/triggers/inboundrules?count=50&offset=0" \
-X GET \
-H "Accept: application/json" \
-H "X-Postmark-Server-Token: server token"
Querystring parameters
count
required Number of records to return per request.
offset
required Number of records to skip.
Response
TotalCount
integer
Indicates how many triggers match the search criteria you specified.
InboundRules
array
List of objects that each represent each inbound rule.
Example response
HTTP/1.1 200 OK
Content-Type: application/json
{
"TotalCount" : 3 ,
"InboundRules" : [
{
"ID" : 3 ,
"Rule" : "someone@example.com"
} ,
{
"ID" : 5 ,
"Rule" : "badsender@example.com"
} ,
{
"ID" : 7 ,
"Rule" : "baddomain.com"
}
]
}
Create an inbound rule trigger
Try →
#
post
/triggers/inboundrules
Request headers
Content-Type
required application/json
Accept
required application/json
X-Postmark-Server-Token
required This request requires server level privileges. This token can be found on the API Tokens tab under your Postmark server.
Example request with curl
curl "https://api.postmarkapp.com/triggers/inboundrules" \
-X POST \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Postmark-Server-Token: server token" \
-d '{
"Rule": "someone@example.com"
}'
Body format
Rule
string
required Email address (or domain) that you would like to block from sending.
Example body format
{
"Rule" : "someone@example.com" ,
}
Response
ID
integer
Unique ID of the trigger
Rule
string
Email address (or domain) that you would like to block from sending.
Example response
HTTP/1.1 200 OK
Content-Type: application/json
{
"ID" : 15 ,
"Rule" : "someone@example.com"
}
Delete a single trigger
Try →
#
delete
/triggers/inboundrules/{triggerid}
Request headers
Accept
required application/json
X-Postmark-Server-Token
required This request requires server level priveledges. This token can be found on the Credentials tab under your Postmark server.
Example request with curl
curl "https://api.postmarkapp.com/triggers/inboundrules/{triggerid}" \
-X DELETE \
-H "Accept: application/json" \
-H "X-Postmark-Server-Token: server token"
Example response
{
"ErrorCode" : 0 ,
"Message" : "Rule someone@example.com removed."
}