The purpose of this document is to provide a guide on how to receive notifications for failed email deliveries.
These notifications will be automatically sent to a specific URL, known as an endpoint, which must be provided by each client who wishes to receive this information.
When a transactional (one-to-one) email is sent, failures may occur that prevent delivery to the final recipient. In these cases, the failed emails are stored so they can be manually reviewed and resent. If the resend also fails, a notification process is triggered automatically.
This system allows clients to stay informed about which emails were not delivered and internally identify whether the failure was due to a validation issue before sending or a system error that requires investigation.
Below are the prerequisites for creating an endpoint to receive failed email delivery notifications:
<aside> 💡 Important: The payload sent to the endpoint must initially match the configuration described in section 4 and be updated with customized information upon request.
</aside>
The client must provide a specific URL (endpoint) where they wish to receive notifications in case of an email delivery failure. This URL will be registered in our system and used to automatically send the appropriate notifications when a failure is detected.
The configuration defines the information that will be sent in the notification.
To register a client for delivery failure notifications, a request must be made via email to [email protected] or by contacting the commercial team directly. The request should include the endpoint URL to be registered and the identifier of the requesting client.