Event catalog
Common structure and how to receive events: see Realtime events and Webhooks.
| type | Description | Notes |
|---|---|---|
message.received |
New message from a customer/group (all channels). data.message has the same shape as GET message, data.conversation summarizes the conversation. | |
message.sent |
Message sent by the account (from the app, phone, API, workflow). | |
message.recalled |
A message was recalled (unsent). data: msg_id, thread_id. | |
message.deleted |
Messages were deleted. data: msg_ids, thread_id. | |
message.reaction |
A reaction was added to a message. data: msg_id, thread_id, user_id, emoji. | |
message.seen |
The customer has seen the message. data: thread_id, msg_id, user_ids. | |
conversation.typing |
Typing (Socket.IO/SSE only, not stored, no webhook). | not stored, Socket.IO/SSE only |
conversation.label.assigned |
A label was assigned to a conversation. data: thread_id, label_id. | |
conversation.label.removed |
A label was removed from a conversation. data: thread_id, label_id. | |
friend.request.received |
New friend request. data: user (id, name, avatar), message. | |
friend.request.sent |
A friend request was sent. | |
friend.request.removed |
A friend request was cancelled/declined. | |
friend.accepted |
The two sides are now friends. data: user_id. | |
group.event |
Group event (join/leave/admin change...). data: group_id, event_type, raw. | |
group.updated |
Group renamed / photo changed. data: group_id, name, avatar_url. | |
poll.vote |
Someone voted in a poll. | |
account.connected |
Account connected. | |
account.disconnected |
Account disconnected. data: reason. | |
account.listener_dead |
The account's message listener died; a reconnect is needed. data: reason. | |
crm.note.saved |
A CRM note was created/updated. | |
crm.note.deleted |
A CRM note was deleted. | |
campaign.changed |
A campaign changed (saved, status changed, recipients added). | |
payment.received |
Payment received through the Casso/SePay integration. | system-wide: keys without an account restriction |
plugin.event |
Event emitted by a plugin (the actual type has the form plugin.<pluginId>.<name>). |
system-wide: keys without an account restriction |
ping |
Test event sent when you click "Test" on a webhook. | system-wide: keys without an account restriction |
Didn't find your answer?
Message us on Telegram