Webhook¶

Webhook is used to track changes in the letter status in real time.

The model used in Webhook works as follows: when an event occurs, the previously installed handler sends JSON to the URL that was indicated for this Webhook. Standard ports are used: port 80 for HTTP and port 443 for HTTPS. To install Webhook on the URL with the specified port, you can send the URL in the form: http://11.111.111.11:80

If the URL to which the Webhook is sent is unavailable (the HTTP 200 OK does not respond, the timeout is 3 seconds), attempts to send the Webhook to this URL, until the expected 200 OK is received, will last for 24 hours with an interval of 10 minutes with the additional retry_count parameter, which will increase by 1 after each Webhook re-sending.

If the Webhook fails to be successfully delivered within 24 hours, the attempts get on hold, and the Webhook status is changed to stopped. Your account is sent a notification email to about the deactivation of the Webhook with its last response. To reactivate the stopped Webhook, correct the error, then activate it with API method setHook with the parameter status="active" or change the status in your Account.

Webhook is a mechanism designed to notify system users about events. Events that can be notified by Webhook:

a change of the letter status (sent, delivered, rejected, read, the recipient followed the link); the contact has unsubscribed from the list/subscribed to another list; a change in the campaign status; a change in the user data; adding the verified return address; a change in the account status; adding a new user (for resellers).

Reference¶

https://selzy.com/en/support/api/common/webhooks-event-notification-system/