Events
Automated opens and clicks by mail security scanners are filtered out. Sample payloads for each event are listed under Webhook Events in the sidebar.
Set up your webhook
- In the dashboard, switch to the workspace that owns your sending domain, go to Integrations, open Deliveryman API Keys and click Manage.
- Under Webhook Events, enter your endpoint URL and click Save webhook. The URL must use
https://and be publicly reachable.
Event format
Every event is aPOST request with a JSON body. All events share the same envelope:
idis unique per event. Use it to ignore duplicate deliveries.typeis the event type.data.message_idmatches themessage_idreturned by Send Email.- The other
datafields depend on the event type.
Respond and retries
Respond with any2xx status within 10 seconds. Do slow work, like calling other APIs, after you respond.
If your endpoint returns another status, times out or can’t be reached, the event is retried 3 more times: after 1, 5 and 15 minutes. Redirects are not followed, so use the final URL.
Events can occasionally arrive more than once or out of order. Use id to ignore duplicates, and the timestamps in data to order them.
If you miss an event, Retrieve Sent Email returns the email’s current status, opens, clicks, bounce and replies.