Postmark | Composio Docs

Overview

SLUG: POSTMARK

Description

Postmark is an email delivery service that enables developers to send transactional emails with high deliverability and detailed analytics.

Authentication Details

API Key

generic_api_key

stringRequired

Connecting to Postmark

Create an auth config

Use the dashboard to create an auth config for the Postmark toolkit. This allows you to connect multiple Postmark accounts to Composio for agents to use.

Select App

Navigate to Postmark.

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

Create and Get auth config ID

Click “Create Postmark Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1 from composio import Composio
2 
3 # Replace these with your actual values
4 postmark_auth_config_id = "ac_YOUR_POSTMARK_CONFIG_ID" # Auth config ID created above
5 user_id = "0000-0000-0000"  # UUID from database/app
6 
7 composio = Composio()
8 
9 def authenticate_toolkit(user_id: str, auth_config_id: str):
10     # Replace this with a method to retrieve an API key from the user.
11     # Or supply your own.
12     user_api_key = input("[!] Enter API key")
13 
14     connection_request = composio.connected_accounts.initiate(
15         user_id=user_id,
16         auth_config_id=auth_config_id,
17         config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18     )
19 
20     # API Key authentication is immediate - no redirect needed
21     print(f"Successfully connected Postmark for user {user_id}")
22     print(f"Connection status: {connection_request.status}")
23     
24     return connection_request.id
25 
26 
27 connection_id = authenticate_toolkit(user_id, postmark_auth_config_id)
28 
29 # You can verify the connection using:
30 connected_account = composio.connected_accounts.get(connection_id)
31 print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Postmark toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

POSTMARK_CHECK_SPAM_SCORE

Tool Name: Check Spam Score

Description

Tool to assess the spam score of a raw email via the SpamCheck API. Use when you have full email source and need spam scoring before sending. Returns spam score and detailed report.

Action Parameters

stringRequired

options

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_CREATE_TEMPLATE

Tool Name: Create Template

Description

Tool to create a new email template. Use when you need reusable templates before sending emails.

Action Parameters

Alias

AssociatedServerId

HtmlBody

stringRequired

LayoutTemplate

Name

stringRequired

Subject

stringRequired

TemplateType

stringRequired

TextBody

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_DELETE_WEBHOOK

Tool Name: Delete Webhook

Description

Tool to delete a specific webhook. Use when you need to remove a webhook by its ID after confirming it's no longer needed.

Action Parameters

webhookID

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_EDIT_SERVER

Tool Name: Edit Server

Description

Tool to update settings for the current Postmark server. Use when you need to modify server configuration.

Action Parameters

BounceHookUrl

Color

DeliveryHookUrl

InboundDomain

InboundHookUrl

InboundSpamThreshold

Name

stringRequired

OpenHookUrl

PostFirstOpenOnly

RawEmailEnabled

SmtpApiActivated

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_EDIT_TEMPLATE

Tool Name: Edit Template

Description

Tool to update an existing Postmark template by its ID. Use when you need to modify a template's name, subject, HTML or text body, alias, type, layout, or active status.

Action Parameters

Active

Alias

HtmlBody

LayoutTemplate

Name

Subject

TemplateType

TextBody

templateID

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_EDIT_WEBHOOK

Tool Name: Edit Webhook

Description

Tool to update an existing webhook’s URL or triggers. Use when you need to modify webhook settings after confirming the webhookID.

Action Parameters

AuthToken

Triggers

objectRequired

Url

stringRequired

webhookID

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_BOUNCES

Tool Name: Get Bounces

Description

Tool to retrieve a list of bounces for a server with optional filters. Use when you need to page through bounce data after applying filters.

Action Parameters

count

emailFilter

fromdate

inactive

mailboxHash

messageID

offset

tag

todate

type

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_BROWSER_PLATFORM_USAGE

Tool Name: Get Browser Platform Usage

Description

Tool to retrieve browser platform usage statistics for clicked links. Use after sending outbound emails with tracked links to analyze engagement by browser.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_BROWSER_USAGE

Tool Name: Get Browser Usage

Description

Tool to retrieve browser usage statistics for clicked links. Use after sending tracked outbound emails to analyze which browsers and platforms were used to click links.

Action Parameters

FromDate

stringRequired

ServerID

ToDate

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_CLICK_COUNTS

Tool Name: Get Click Counts

Description

Tool to retrieve total click counts across all links in emails. Use when you need aggregated click metrics for a given date range.

Action Parameters

client_name

country

fromdate

stringRequired

platform

tag

todate

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_DELIVERY_STATS

Tool Name: Get Delivery Stats

Description

Tool to retrieve delivery statistics. Use after sending emails to get aggregated counts of deliveries, bounces, and spam complaints.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_EMAIL_CLIENT_USAGE

Tool Name: Get Email Client Usage

Description

Tool to retrieve statistics on email clients used to open emails. Use when you need to analyze which clients recipients open your outbound emails.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_EMAIL_OPEN_COUNTS

Tool Name: Get Email Open Counts

Description

Tool to retrieve counts of opened emails. Use when you need per-day and total open stats for a specified period.

Action Parameters

FromDate

MessageStream

ToDate

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_OUTBOUND_OVERVIEW

Tool Name: Get Outbound Overview

Description

Tool to retrieve outbound email statistics overview. Use when you need aggregated outbound metrics after sending emails.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_SERVER

Tool Name: Get Server

Description

Tool to retrieve details of the current Postmark server. Use when you need to inspect server configuration (webhooks, tracking, tokens, etc.) before other operations.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_SPAM_COMPLAINTS

Tool Name: Get Spam Complaints

Description

Tool to retrieve counts of spam complaints. Use when analyzing spam feedback trends after sending campaigns.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_TEMPLATE

Tool Name: Get Template

Description

Tool to retrieve details of a specific template by its ID. Use after obtaining a template ID to inspect its configuration.

Action Parameters

templateID

integerRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_GET_TRACKED_EMAIL_COUNTS

Tool Name: Get Tracked Email Counts

Description

Tool to retrieve counts of emails with tracking enabled. Use after specifying a date range to analyze open and click metrics.

Action Parameters

fromdate

stringRequired

todate

stringRequired

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_LIST_TEMPLATES

Tool Name: List Templates

Description

Tool to list all templates for a Postmark server. Use when you need to retrieve available templates with optional pagination and filters.

Action Parameters

count

offset

templateActive

templateType

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_LIST_WEBHOOKS

Tool Name: List Webhooks

Description

Tool to list all webhooks configured for your Postmark account. Use after authenticating your server token to retrieve current webhook configurations.

Action Parameters

Action Response

data

objectRequired

error

successful

booleanRequired

POSTMARK_SEND_BATCH_WITH_TEMPLATES

Tool Name: Send Batch Templated Emails

Description

Tool to send multiple templated emails in a single batch API call. Use when you need to send up to 500 templated messages at once.

Action Parameters

Messages

arrayRequired

Action Response

data

arrayRequired

error

successful

booleanRequired

POSTMARK_VALIDATE_TEMPLATE

Tool Name: Validate Template

Description

Tool to validate a Postmark template. Use when checking that a template's subject and body render correctly against sample data.

Action Parameters

HtmlBody

Subject

TemplateType

stringRequired

TestRenderModel

objectRequired

TextBody

Action Response

data

objectRequired

error

successful

booleanRequired