REST Resource: conversations.events

  • An Event signifies an occurrence within a conversation between an agent and a user, encompassing actions like typing or a representative joining/leaving.

  • Events are characterized by attributes such as 'name', 'eventType', and 'representative', providing detailed context about the event.

  • 'EventType' categorizes the nature of the event, including options like "TYPING_STARTED", "REPRESENTATIVE_JOINED", etc.

  • Developers can utilize the 'create' method to initiate an event within a conversation programmatically.

Resource: Event

An event in a conversation between an agent and a user.

JSON representation 
{
  "name": string,
  "eventType": enum (EventType),
  "representative": {
    object (Representative)
  }
}
Fields
name

string

The name of the event, as set by Business Messages. Resolves to "conversations/{conversationId}/events/{eventId}", where {conversationId} is the unique ID for the conversation and {eventId} is the unique ID for the event.
eventType

enum (EventType)

The type of the event.
representative

object (Representative)

Details about the representative (human or chatbot) that sent the event.

EventType

Type of an agent event.

Enums
EVENT_TYPE_UNSPECIFIED Not specified.
TYPING_STARTED The representative is typing.
TYPING_STOPPED The representative stopped typing.
REPRESENTATIVE_JOINED The representative joined the conversation.
REPRESENTATIVE_LEFT The representative left the conversation.

Methods

create

 Creates an event in a conversation.