Skip to main content
This document contains a reference of pushes available in the Agent Chat API. Similarly to webhooks, pushes notify you when specific events occur. They’re usually generated as result of RTM API actions, but it’s also possible to receive them in result of Web API actions. Here’s what you need to know about pushes:
  • They are generated primarily by RTM API actions, but also by Web API actions.
  • They notify you when specific events occur.
  • Can be delivered only in the websocket transport.
  • You don’t need to register pushes to receive them.
  • Their equivalents in Web API are webhooks. Pushes and webhooks have similar payloads.
  • There are no retries for pushes. To determine if a user has seen an event, compare the event’s created_at parameter with the user’s events_seen_up_to field.

Available pushes

Chats

incoming_chat

Indicates about a chat coming with a new thread. The push payload contains the whole chat data structure. If the chat was started with some initial events, the thread object contains them.

chat_deactivated

Indicates that a chat was deactivated by closing the currently open thread.

chat_deleted

Indicates that a chat was deleted.

thread_deleted

Indicates that a thread was deleted.

threads_deleted

Indicates that several threads from a specific date range or with the same tag were deleted.

Chat access

chat_access_updated

Indicates about the update of a user’s access to a particular chat. It contains the updated access data structure.

chat_transferred

Indicates that a chat was transferred to a different group or to an agent.

Chat users

user_added_to_chat

Indicates that a user (customer or agent) was added to a chat.

user_removed_from_chat

Indicates that a user (customer or agent) was removed from a chat.

Events

incoming_event

Indicates about an incoming event sent to a chat.

event_deleted

Indicates that an event was deleted.

event_updated

Indicates that an event was updated.

incoming_rich_message_postback

Indicates about an incoming rich message postback. The push payload contains the info on the postback itself, as well as the chat it was sent in.

Properties

chat_properties_updated

Indicates about those chat properties that were updated.

chat_properties_deleted

Indicates about those chat properties that were deleted.

thread_properties_updated

Indicates about those thread properties that were updated.

thread_properties_deleted

Indicates about those thread properties that were deleted.

event_properties_updated

Indicates about those event properties that were updated.

event_properties_deleted

Indicates about those event properties that were deleted.

Thread tags

thread_tagged

Indicates that a chat thread was tagged.

thread_untagged

Indicates that a chat thread was untagged.

Customers

incoming_customers

Indicates about customers the agent should be aware of. It’s sent after login.

incoming_customer

Indicates that a new or returning customer is available to the agent. It’s sent when:
  • a new customer registers.
  • a customer, who previously left the tracked website, returns.
  • an already followed customer, who was temporarily unavailable to the agent, becomes available again (for example, the customer was transferred between groups).

customer_updated

Indicates that customer’s data changed. The push payload contains the updated fields.

customer_properties_values_updated

Indicates that the values of customer properties were updated.

customer_page_updated

Indicates that a customer moved to another page of the website.

customer_statistics_updated

Indicates that the customer’s statistics were updated.

customer_banned

Indicates that a customer was banned for a specified number of days.

customer_transferred

Indicates that a customer is no longer available to the agent.

customer_left

Indicates that a customer left the tracked website.

subscribed_customers_totals_updated

Indicates that number of customers matching subscription changed. This push is sent periodically once limits are reached.

ticket_created

Indicates that a ticket was created for a tracked customer.

ticket_deleted

Indicates that a ticket was deleted for a tracked customer.

Status

routing_status_set

Indicates that an agent’s or bot agent’s status was changed.

agent_disconnected

Indicates that an agent was disconnected. The payload contains the reason of the agent’s disconnection.
Based on the received reason we suggest a different reaction. *) Also, misdirected_connection returns the correct region value in the optional data object. With this piece of information, the client is able to figure out where it should be connected.

Configuration

agent_created

Indicates that a new agent account was created. The payload contains the full state of the agent data structure, including empty fields.

agent_approved

Indicates that an agent’s account was approved and is now active.

agent_updated

Indicates that an agent’s configuration changed. Contains only the updated properties.

agent_suspended

Indicates that an agent’s account was suspended.

agent_unsuspended

Indicates that an agent’s account was unsuspended.

agent_deleted

Indicates that an agent’s account was deleted.

auto_accesses_updated

Indicates that auto access rules were modified. The payload contains an array of all changes done as result of adding, updating, or deleting auto access rule. The resulting payload can contain multiple objects depending on the action:
  • for the added auto access rule, the payload contains the complete state of the auto access rule data structure, including empty fields.
  • for the updated auto access rule, the payload contains only the updated properties.
  • for the deleted auto access rule, the payload confirms the deletion.
Sample push payload after adding auto access rule:
Sample push payload after updating auto access rule:
Sample push payload after deleting auto access rule:

bot_created

Indicates that a new bot was added. The payload contains the full state of the bot data structure, including empty fields.

bot_updated

Indicates that a bot’s configuration changed. Contains only the updated properties.

bot_deleted

Indicates that a bot was deleted.

group_created

Indicates that a group was created within a license. The payload contains the full state of the group data structure, including empty fields.

group_deleted

Indicates that a group was deleted within a license.

group_updated

Indicates that a group was updated within a license. The push payload only includes the updated fields.

tag_created

Indicates that a tag was created within a license. The payload contains the full state of the tag data structure, including empty fields.

tag_deleted

Indicates that a tag was deleted within a license.

tag_updated

Indicates that a tag was updated within a license.

groups_status_updated

Indicates that the statuses of groups that the agent has access to were updated. The push payload only includes the updated fields. Possible statuses: accepting_chats, not_accepting_chats, offline.

license_properties_updated

Indicates about those license properties that were updated.

group_properties_updated

Indicates about those group properties that were updated.

customer_property_definition_created

Indicates that a customer property definition was created within an organization. The payload contains the full state of the customer property definition.

customer_property_definition_updated

Indicates that a customer property definition was updated within an organization. The payload contains the full current state of the customer property definition, including the fields that didn’t change.

Other

incoming_thinking_indicator

Indicates that one of the chat users (an agent or a bot agent) is currently preparing a response. The message hasn’t been sent yet.

incoming_typing_indicator

Indicates that one of the chat users (an agent or a bot agent) is currently typing a message. The message hasn’t been sent yet. The push payload contains the typing indicator object.

incoming_sneak_peek

Indicates that a customer is currently typing a message. The push payload contains the sneak peek object.

events_marked_as_seen

Indicates that a user has seen events up to a specific time.

incoming_multicast

Indicates about messages sent via the multicast method or by the system.

chat_unfollowed

Indicates that a chat has been unfollowed. Useful in multiple connection scenarios, where one app/integration needs to know that another one unfollowed the chat.

queue_positions_updated

New positions and wait times for queued chats.

thread_summary_set

Indicates that a thread summary was generated and set.

incoming_error

Indicates an error occurred during processing of an asynchronous query (e.g. after calling request_thread_summary).