SAsalesforce
events

Get event

Changed on

This route is used to retrieve a single event.

get/events/{key}

Request

  • Base URL
    /v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/events/{key}
  • Auth
    API key in header Authorization

Path parameters

keystring required

The id the event to retrieve

Query parameters

limitinteger

Maximum number of records to return in the response; also useful for pagination in the UI.

offsetinteger

Offset for paginating the response.

Response

Success, returns specified event

idstring

The UUID of the specified event

logstring

Human readable log line describing the event and its context it stores

contextobject

A object, typically JSON, that contains the information to describe an event

actionTypestring

This is the type of the event

roomIdinteger

The room ID in which the event deals with

botIdstring

The bot ID in which the event deals with

botDataIdstring

The bot data ID in which the event deals with

botActionIdstring

The bot action ID in which the event deals with

userIdstring

The user ID in which the event deals with

Changes