Setting Up Delivery Notifications for Your App
Tell your application when an email arrives or bounces, test the connection, and inspect failed notifications.
Delivery notifications tell your software when an event happens, such as a message arriving or bouncing. They go to an application endpoint, not to a person's email inbox. Your developer prepares that endpoint.
Add the connection
- Open Delivery notifications in the Transactional email workspace, or go to Notify my application.
- Click Add an address.
- Enter your application's HTTPS endpoint in Address. It must be reachable from the internet.
- Add a description under What is it for.
- Under Tell it about, choose the events the app needs.
- Click Save.
Give your developer the webhook documentation. They need to verify the signing secret and handle retries safely before relying on notifications.
Send a test
Click Send a test beside the endpoint, then check What we have sent. Open Details for the result and each delivery attempt.
- Accepted means your application accepted the notification.
- Trying means delivery is still being attempted.
- Gave up means attempts stopped. Open the details for the error.
These are notification-delivery results, separate from the delivery status of the customer's email.
When a notification fails
Ask your developer to check that the endpoint is reachable, accepts the notification and verifies it with the current signing secret. The details show the event ID, attempts and payload. The history covers the last 30 days.
A notification may be delivered more than once. Your application should recognise the event ID and avoid acting on the same event twice. Notifications can also arrive out of order.
Pause or change the connection
Use Edit to change the endpoint or events, Pause to stop notifications temporarily, and Turn on to resume. Remove stops notifications to that endpoint.
Replace beside the signing secret changes the secret. Coordinate it with your developer: the app must use the new secret to verify subsequent notifications. Keep the secret out of public code and support messages.