Webhooks
email.opened
Sent when the tracking pixel in an HTML email loads. The payload carries the IP address and user agent of the client that fetched it, so you can tell which mail client rendered the message.
What the event tells you
A pixel load, not a reader
Some mail clients block remote images and others load them automatically. Treat the event as a signal.
The client string is included
user_agent is the raw string, so you can identify the mail client on your side.
The IP of the request
ip is the address of the request that loaded the pixel, as recorded.
Quick repeats are ignored
A load within 60 seconds of the last open does not send another event.
Fields in data
- Common fields
- email_id, message_id, from, to, subject, status, tags, created_at.
- ip
- The IP address of the request that loaded the pixel.
- user_agent
- The raw client string.
- message_id
- PostFrame's message identifier. The key is message_id, in snake case.
- tags
- The email's tags, for attribution.
"status": "opened",
"ip": "<ip address>",
"user_agent": "<client string>"PostFrame, answered
What is in the email.opened payload?
The common fields (email_id, message_id, from, to, subject, status, tags, created_at) plus ip and user_agent from the request that loaded the pixel.
How do I verify the request came from PostFrame?
Every request carries X-PostFrame-Signature (v1=<hex>) and X-PostFrame-Timestamp. Recompute HMAC-SHA256 over "<timestamp>.<body>" with the endpoint's signing secret, using the body exactly as received, and compare in constant time. The Node and Python snippets shown in the dashboard check this same scheme. The signing secret can be rotated through the API.
What happens if my endpoint is down?
PostFrame retries a failed delivery up to 4 times, waiting 10, 20, 40 and 80 seconds, and the endpoint's delivery log keeps one entry per delivery with the event type, last HTTP status, timing and attempt number. After the last attempt the event is not sent again. Each attempt times out after 10 seconds and redirects are not followed.
Can I try the endpoint before real traffic arrives?
Yes. Each endpoint has a Test action that sends a test event to your URL. Emails sent in test mode, for example with a pf_test_ API key, never dispatch webhooks.
Run your business from one place.
Five plans, 25 launch apps, one dashboard. Change tiers any time.
From $0 · Basic $9.95/mo · Upgrade or downgrade any time