The Salesforce Developers website will undergo maintenance on May 29, 2024 from 3:00 a.m. UTC to 10:00 a.m. UTC. The maintenance process may affect the availability of our documentation. Please plan accordingly.

Server-Sent Events Structure

Clients subscribe to the Server-Sent Events endpoint to receive server-side events.

These events encompass diverse message entries and provide supplementary information related to the conversation entry.

For a comprehensive understanding of the various supported message types and formats, please refer to the “Message Types & Format Types” section.

The CONVERSATION_ROUTING_RESULT event handles routing to an agent or chatbot, such as when a conversation is initially created or when a conversation is transferred from a chatbot to an agent.

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.

The CONVERSATION_PARTICIPANT_CHANGED event handles when a new participant joins a conversation or an existing participant leaves. This event applies to a participant other than the end user using the Messaging for In-App and Web client.

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.

The CONVERSATION_MESSAGE event handles when a conversation message comes through the event source (SSE).

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.

The CONVERSATION_DELIVERY_ACKNOWLEDGEMENT event handles when an end user receives an acknowledgment for their message when it is ‘Delivered’.

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.

The CONVERSATION_READ_ACKNOWLEDGEMENT event handles when an end user receives an acknowledgment for their message when it is ‘Read’.

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.

The CONVERSATION_TYPING_STARTED_INDICATOR event handles when the client receives a “typing started” indicator when the other participant, such as an agent or chatbot, starts typing a message.

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.

The CONVERSATION_TYPING_STOPPED_INDICATOR event handles when the client receives a “typing stopped” indicator when the other participant, such as an agent or chatbot, stops typing a message.

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.

The CONVERSATION_CLOSE_CONVERSATION event handles when the client receives an indicator or a confirmation that the conversation is closed.

Add the following payload to the Server-Sent Events Server-Sent Events endpoint.