Webhooks
Webhook event types
The events Deckle sends to your endpoints, and what each one means.
Every webhook delivery has a type that tells you what happened, and a data object with the details. Subscribe an endpoint to the events you care about and Deckle POSTs each one to you as it fires.
Events#
Deckle emits five email lifecycle events. Delivery, bounce, and complaint events come straight from AWS SES; opens and clicks are tracked on template sends. Each event is delivered to every active endpoint subscribed to it.
| Event | Fired when |
|---|---|
email.delivered | SES confirmed the message was delivered to the recipient's mail server. |
email.bounced | The message hard-bounced. The address is also added to your suppression list. |
email.complained | The recipient marked the message as spam. The address is also added to your suppression list. |
email.opened | The tracking pixel was loaded — the recipient opened the email. |
email.clicked | The recipient clicked a tracked link in the email. |
Also: test.ping
The Send test event button in the dashboard delivers atest.ping event so you can confirm your endpoint is reachable before real events start flowing.The data object#
Each event's data object carries the email log id, the recipient, and the subject — enough to tie the event back to the message you sent. email.clicked events also include the url that was clicked, so you can attribute engagement to a specific link.
Full payload schemas
The exact fields on each event'sdata object live in the webhook events API reference.