A webhook is an HTTP callback that allows a web application to POST a message to a URL when certain events take place. Often called “Reverse APIs,” Webhooks can be used to receive data in real time, pass it on to another application, or process the data faster than traditional APIs.
The Webhook notifies the URL via HTTP POST about events that take place with your email in the SmartSender.io platform. The Webhook then captures email-specific data related to unsubscribes, spam reports, bounced emails, and response data, and reports them in the manner in which you specify.
- Navigate to Webhook management page (Menu -> Integrations).
- Select the “Webhooks” section.
- Press the “Create ” button.
- Type the title of the webhook in the “Name” field.
- Select the Project Domain.
- Type in the URL, to which a message should be posted.
- Select one or several events.
- Click on the “Create” button.
The list of earlier created webhooks will be seen on the Webhooks page.
Events and triggers you are able to choose:
Description Message Status Message is Delivered The Delivered status is assigned as soon as
the message sent by SmartSender was accepted by the recipient’s ISP
Message is Rejected The message has been rejected by ESP. Message is Bounced The time and hard-bounce code received from the
ISP. A hard bounce indicates a permanent reason why an email cannot be
delivered. Hard bounced email addresses are immediately automatically placed
in the sender’s account BlackList to
prevent degradation of the sender’s domain reputation.
Contact Event Contact Subscribes To Email The contact confirmed that agrees to get
Recipient Unsubscribes From Email This action unsubscribes the recipient from a
Contact Activated The contact will be activated in the Contact
Contact Deactivated The contact will be deactivated in the Contact
Contact unsubscribes using List-Unsubscribe
The contact pressed the Unsubscribe Link inside
the message. That contact is automatically moved to the BlackList.
Message Event Message Is Read The read status is assigned every time this
message has been opened by the user. The message includes information on
Message Is Clicked The click status is assigned every time tracked
URLs in this message have been clicked by the user. The message includes
information on each click.
Message Is Marked As Spam The recipient moved the message from Inbox to
the Spam folder. Messages from the same sender might be sent to Spam in
SMS Description SMS is Delivered The carrier server accepted & queued for delivery this message.
WebPush Description Message Status WebPush Notification Is Delivered The WebPush notification has reached the recipient’s browser. WebPush Notification Undelivered The Push notification wasn’t delivered, an invalid token. WebPush Notification Is Expired by TTL The Push notification wasn’t shown due to TTL (Time to live). Contact Event WebPush Desktop Permission Is Declined The recipient has explicitly denied permission to show notifications. WebPush Desktop Permission Is Granted The recipient has allowed permission to display Desktop WebPush notifications, after having been asked previously. WebPush Desktop Is Unsubscribed The recipient dismissed the permission to get WebPush Desktop notifications. WebPush Mobile Permission Is Declined The recipient dismissed the permission to get WebPush Mobile notifications. WebPush Mobile Permission Is Granted The recipient has allowed permission to display Mobile WebPush notifications, after having been asked previously. WebPush Mobile Is Unsubscribed The recipient dismissed the permission to get WebPush Mobile notifications. Message Event WebPush Notification Is Clicked The recipient followed a link in the content of the WebPush Notification. WebPush Notification Is Displayed The WebPush Notification is shown on the recipient’s device. WebPush Notification Is Closed by User The WebPush Notification is shutted down by the recipient.
Telegram Description Message Status Telegram Message is delivered The message has reached the recipient’s Telegram. Telegram Message is failed The Telegram message delivery was not successful. Contact Event Contact subscribed to telegram bot The contact launched the /start command to agree for getting mailing. Contact unsubscribed from telegram bot The contact launched the /end command to refuse for getting mailing. Contact subscribed to telegram channel The contact confirmed that agrees to get messages from the specific telegram channel. Contact unsubscribed from telegram channel The contact pressed the unsubscribe button to stop getting the messages from the specific telegram channel. Message Event Telegram Message is viewed The recipient opened the channel and reached the specific message or marked it as read. Telegram Message is clicked The recipient followed a link in the content of the Telegram Message.
Successful. 200 – OK. The 200 status code means that the request was received and understood and is being processed.
If the webhook delivery fails, we will make 15 attempts to deliver the webhook before dropping it from the queue:
|Number of attempts||Seconds between attempts|