List Link Clicks
postmark.list_message_clicks
ActionEmailconnection required
Calls the Postmark API with the connection's credentials.
List recorded link clicks across the server, or every click on one message when a message id is given.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Postmark
- Secret shape
- the server API token, or {"server_token": "…"}
- Config it needs
- message_stream, from_address, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
count How many clicks to return in one page. Postmark's maximum is 500. | number | No | 50 | 1–500 | — |
offset How many records to skip before the page starts, for paging through results. | number | No | 0 | 0–1000000 | — |
recipient Only records for this recipient address. Postmark matches it as a prefix. | string | No | — | — | — |
tag Only records whose message carried this Postmark tag. | string | No | — | — | — |
message_id Only the clicks on this one Postmark MessageID. Leave blank for the whole server. | string | No | — | — | — |
message_stream The message stream to read clicks from. Leave blank to use the stream on the connection, which defaults to Postmark's 'outbound' stream. | string | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"count": 50,
"offset": 0
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items The records on this page, exactly as Postmark returned them. | array | — |
count How many records are on this page. | number | — |
total_count How many records match the filter in total, across every page. | number | — |
{
"count": 0,
"items": [],
"total_count": 0
}Notes
- Clicks are only recorded for messages sent with link tracking on.
See List Link Clicks run in a workflow.
In a technical demo we add the Postmark connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.