Method: conversations.events.create

  • An event in a conversation is created using an HTTP POST request to the specified URL.

  • The parent parameter is required and identifies the conversation containing the message.

  • The eventId query parameter is a unique identifier for the event, assigned by the agent.

  • The request body contains an instance of the Event object, and the response body returns a newly created Event instance if successful.

  • Creating events requires the https://www.googleapis.com/auth/businessmessages OAuth scope.

Creates an event in a conversation.

HTTP request

POST https://businessmessages.googleapis.com/v1/{parent=conversations/*}/events

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The conversation that contains the message. Resolves to "conversations/{conversationId}".

Query parameters

Parameters
eventId

string

The unique identifier of the event, assigned by the agent. If an event has the same eventId as a previous event in the conversation, Business Messages returns an ALREADY_EXISTS error.

Request body

The request body contains an instance of Event.

Response body

If successful, the response body contains a newly created instance of Event.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/businessmessages

For more information, see the OAuth 2.0 Overview.