Webhooks

email.unsubscribed

The event for a recipient unsubscribe. Its payload is the common email fields plus the method that was used and the IP address of the request.

What the event carries

  • The unsubscribe link is signed

    Each link carries a token bound to the email it was sent in, so nobody can unsubscribe someone else. A token that fails verification is refused.

  • One request, one method

    The method field is list-unsubscribe-post. The link in the email opens a confirmation page whose button sends that same request.

  • The IP of the request

    ip is the address of the request that carried the unsubscribe.

  • Groups work differently

    Opting a contact out of an unsubscribe group is a stored preference, not this event. See unsubscribe management.

Fields in data

Common fields
email_id, message_id, from, to, subject, status, tags, created_at.
method
list-unsubscribe-post.
ip
The IP address of the request.
timestamp
Unix seconds, at the top level of the request body, outside data.
Fields added to data
"method": "list-unsubscribe-post",
"ip": "<ip address>"
Questions

PostFrame, answered

What is in the email.unsubscribed payload?

The common fields (email_id, message_id, from, to, subject, status, tags, created_at) plus method and ip.

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