Events
event is a reaction to an event occurring in a channel, account, or project.
Common events
| Event | Description |
|---|---|
tariffBlocked |
The account is blocked |
sessionDataSoftLimitExceeded |
The soft limit of saving data to the object $session is reached |
clientDataSoftLimitExceeded |
The soft limit of saving data to the object $client is reached |
sessionDataHardLimitExceeded |
The hard limit of saving data in the object $session is reached |
clientDataHardLimitExceeded |
The hard limit of saving data in the object $client is reached |
smsFailedEvent |
The SMS message hasn’t been sent to the client |
smsSuccessEvent |
The SMS message has been successfully sent to the client |
STS classifier events
| Event | Description |
|---|---|
match |
Sent text is detected |
noMatch |
Sent text is unrecognized |
timeLimit |
Request processing time limit is exceeded |
lengthLimit |
Limit on the number of characters is exceeded |
Channel events
The fileEvent and fileTooBigEvent events are supported by all inbound channels, except JivoChat, Zendesk, and Zendesk Chat. The chat widget supports fileEvent only.
Bitrix24
| Event | Description |
|---|---|
ONAPPINSTALL |
Application is installed |
ONAPPUPDATE |
Application is updated |
ONIMBOTMESSAGEADD |
The bot received a message |
ONIMBOTMESSAGEUPDATE |
The bot updated the message |
ONIMBOTMESSAGEDELETE |
The bot deleted the message |
ONIMCOMMANDADD |
The bot received a command |
ONIMJOINCHAT |
The bot has been informed about its inclusion in a chat or personal messages |
ONIMBOTDELETE |
The bot has been removed |
CRM_SUCCESS_EVENT |
The CRM event Bitrix24 has been updated |
CRM_FAILED_EVENT |
The CRM event Bitrix24 has not been updated |
edna WhatsApp
Learn more about connecting the edna WhatsApp channel
The edna WhatsApp channel supports locationEvent, which is triggered when the client sends the location.
Telegram
Learn more about connecting the Telegram channel
| Event | Description |
|---|---|
telegramSendContact |
The client sent a contact |
telegramSendLocation |
The client sent a location |
telegramApiRequestFailed |
Failed to upload a file |
telegramCallbackQuery |
Click on the button with callback_data |
stickerEvent |
The client sent a sticker The sticker data will be saved into $request.data.eventData |
telegramPaymentSuccessEvent |
The payment was successful |
telegramPaymentFailedEvent |
The payment failed or an error occurred because parameters were filled incorrectly |
telegramPrecheckoutEvent |
Telegram sent data to check the goods availability |
Handling the telegramPaymentSuccessEvent, telegramPaymentFailedEvent, and telegramPrecheckoutEvent events is only needed
if you set up payments using the telegramPayment reply type.
If you use the TelegramPayment custom tag,
the handling of these events is already built into it.
Viber
Learn more about connecting the Viber channel
| Event | Description |
|---|---|
viberSendLocation |
The client sent a location |
viberSendSticker |
The client sent a sticker |
viberSendContact |
The client sent a contact |
viberUnsubscribe |
The client unsubscribed from the bot. The bot will not be able to send any new messages |
conversationStarted |
The bot had sent a greeting message in the conversation before the session started |
When using the conversationStarted event, there may be a divergence in the number of unique users displayed on the Account management page with the data the account manager has. Please contact your account manager for up-to-date information.
Vonage
Learn more about connecting the Vonage channel
When any non-text message is received in the Vonage WhatsApp channel, then an event with the name of the reply type is sent to the script. For example, event: audio. In this case, eventData receives the entire incoming request from Vonage WhatsApp.
Webim (External Bot API 2.0)
Learn more about connecting the Webim (External Bot API 2.0) channel
The Webim (External Bot API 2.0) channel supports the noLivechatOperatorsOnline event, which is triggered when no agents are online.
Learn more about connecting the WeChat channel
| Event | Description |
|---|---|
weChatSendLocation |
The client sent a location |
weChatAnyMessage |
Could not identify the message type |
Customer engagement platforms
| Event | Description |
|---|---|
livechatFinished |
The agent ended the conversation |
noLivechatOperatorsOnline |
No agents are online |
The livechatFinished is not supported in the Webim customer engagement platform.
Telephony
Learn more about connecting telephony
| Event | Description |
|---|---|
hangup |
The client hung up |
transfer |
The call was transferred to the agent |
botHangup |
The conversation is over at the chatbot’s request |
noDtmfAnswerEvent |
The customer has not entered the DTMF message (tone dialing) |
speechNotRecognized |
The client request could not be recognized within 5 seconds or nothing has come up to recognition |
onCallNotConnected |
The bot could not reach the client. |
bargeInIntent |
The bot made a conditional barge-in attempt. |