Action hooks event types
| Interface name | API name | Description |
|---|---|---|
| Email channel events | ||
| Send | send | Email is sent to a recipient. |
| Reply | reply | Subscriber's reply to received email. |
| Unique Open | uopen | Unique email message opening. |
| Open | open | Any email opening. |
| Unique Click | uclick | Unique email link click. It creates open and uopen events when open event is not captured. |
| Click | click | Any email link click. |
| Confirm | confirm | Confirmation link click in a regular message (creates click and uclick, if it is the first click for this message). |
| Confirm Subscription | confirmsub | Confirmation link click in a double opt-in message. |
| Unsubscribe | unsub | Recipient opted out by clicking a message link {unsubscribe} or {globalunsubscribe}. |
| Complain | complain | A recipient complained or reported spam. |
| SoftBounce | sbounce | Temporary delivery problems provider message. Soft bounce. |
| HardBounce | hbounce | Invalid address or similar delivery problems message. Hard bounce. |
| Suppression | suppress | Email was not sent: recipient address is in suppression list. |
| Delivered | deliv | Email delivered to a recipient. |
| Undelivered | undeliv | Email could not be delivered. |
| Read Message | read | Message remained open for 8 seconds or longer. |
| Glanced Message | glanced | Message remained open for less than 4 seconds. |
| Skimmed Message | skimmed | Message remained open for 4 to 8 seconds. |
| Subscriber Profile Import Events | ||
| Manual Import | import_manual | Manual profile import via platform interface. |
| File Import | import_file | From file profile import via platform interface. |
| API Import | import_api | API profile import. |
| SMS channel events | ||
| Send SMS | send_sms | SMS sent to a recipient. |
| Click SMS | click_sms | Any SMS link click. |
| Unique Click SMS | uclick_sms | Unique SMS link click. |
| Delivered SMS | deliv_sms | SMS delivered to a recipient. |
| Undelivered SMS | undeliv_sms | SMS could not be delivered. |
| Unsubscribe SMS | unsub_sms | Recipient opted out by clicking a message link {unsubscribe} or {globalunsubscribe}. |
| Push channel events | ||
| Unique Open Push | uopen_push | Unique push open. |
| Open Push | open_push | Any push open. |
| Send Push | send_push | Push sent to a recipient. |
| Click Push | click_push | Any push link click. |
| Unique Click Push | uclick_push | Unique push link click. |
| Delivered Push | deliv_push | Push delivered to a recipient. |
| Undelivered Push | undeliv_push | Push could not be delivered to a recipient. |
| SoftBounce Push | sbounce_push | Temporary delivery failure (network issues, push service unavailability for any reason). This event means that the platform will continue attempting to deliver the message. |
| Hardbounce Push | hbounce_push | Permanent delivery failure (Invalid subscription id). After receiving such a response, the platform will not attempt to deliver the message again. |
| Custom (API) opt out | ||
| API unsubscribe | unsub_api | API profile opt out. |
| Campaign launch | ||
| Campaign launch | campaign_launch | Campaign launch. It has a custom hook message structure. |
| Campaign errors | ||
| General: Error | camp_error | Errors that occurred during the campaign. |
| The events that are captured by Pixels in the external resources | ||
| Pixel Open | pixel_open | Pixel script activation. You can find out more about the parameters of this request there. |
| Promo code events | ||
| Promocode Attach | promocode_attach | The subscriber is assigned a promotional code. |
| Promocode Detach | promocode_detach | The promo code is unlinked from the subscriber's profile. |
| Promocode Activate | promocode_activate | The promo code is activated. |
| Events related to the automatic creation of a static segment during import | ||
| Static Segment Added | segs_add | The profile entered the static segment. |
| Static Segment Removed | segs_remove | The profile exited the static segment. |
| Events of merging multiple profiles or splitting one profile | ||
| Profile merge | profile_merge | Multiple profiles are merged into a new or existing profile through an API request. |
| Profile split | profile_split | A profile is divided into several new or existing profiles through an API request. |
| Telegram Bot events | ||
| Telegram bot send | telegram_bot_send | Message has been sent for delivery to a subscriber in a chat with a Telegram bot. |
| Telegram bot delivered | telegram_bot_deliv | The message has been delivered to a chat with a Telegram bot. |
| Telegram bot click | telegram_bot_click | A non-unique click on a link in a message in a chat with a Telegram bot. |
| Telegram bot unique click | telegram_bot_uclick | A unique click on a link in a message. |
| Telegram bot undelivered | telegram_bot_undeliv | The message has not been delivered to a chat with a Telegram bot. |
| Telegram bot subscription | telegram_bot_subscribe | A profile has subscribed to a bot by initiating a dialogue. |
| Telegram Group events | ||
| Telegram group send | telegram_group_send | Message has been sent for delivery to a subscriber in a chat with a Telegram bot. |
| Telegram group delivered | telegram_group_deliv | Message has been delivered in a Telegram group. |
| Telegram group click | telegram_group_click | Click on the link in the message in a Telegram group. |
| Telegram group undelivered | telegram_group_undeliv | Message has not been delivered to a Telegram group. |
| WhatsApp events | ||
| WhatsApp send | whatsapp_send | Message has been sent for delivery to a subscriber in a WhatsApp chat. |
| WhatsApp deliv | whatsapp_deliv | Message has been delivered in a WhatsApp chat. |
| WhatsApp click | whatsapp_click | A non-unique click on a link in a message in a chat. |
| WhatsApp unique click | whatsapp_uclick | A unique click on a link in a message. |
| WhatsApp undeliv | whatsapp_undeliv | Message has not been delivered in a WhatsApp chat. |
| WhatsApp read | whatsapp_read | Message has been read by a user. |
| WhatsApp subscription | whatsapp_subscribe | Profile has been subscribed to a WhatsApp channel. |
| WhatsApp unsubscribe | whatsapp_unsub | Profile has been unsubscribed from a WhatsApp channel. |
| Viber events | ||
| Viber send | viber_send | Message has been sent for delivery to a subscriber in a Viber chat. |
| Viber deliv | viber_deliv | Message has been delivered in a Viber chat. |
| Viber click | viber_click | Click on a link in the message. If the recipient clicks on the same link multiple times, each click event is recorded. |
| Viber unique click | viber_uclick | Unique click on a link in the message. If the recipient clicks on any link at least once, one unique click event is recorded. |
| Viber undeliv | viber_undeliv | Message was rejected by Viber or Devino.Online. |
| Viber read | viber_read | Message was read by the recipient. |
| Viber subscription | viber_subscribe | Profile subscribed to the Viber channel, i.e., agreed to receive messages from the business account. |
| Viber unsubscribe | viber_unsub | Profile unsubscribed from the Viber channel, i.e., blocked receiving messages from the business account. |
| Pop-up events | ||
| Popup: Post | popup_post | The popup form has been completed and submitted. |
Popup: Click | popup_click | Click on any popup element except the "Close" button. |
Popup: Error | popup_error | Any error in the popup. |
Popup: Bounce | popup_bounce | While submitting the popup form, technical problems occurred (for example, a server failure). |
Popup: Close | popup_close | Click on the "Close" button in the popup. |
Popup: Open | popup_open | he popup is shown to the user. |
Popup: Custom | popup_custom | An event configured on the client side was registered. |