listEvents

Retrieves a list of Event you’ve previously created. The events are returned in sorted order, with the most recent appearing first.

GET /v1/chat/events

Try it

cURL

cURL

curl --request GET \
  --url https://api.botpress.cloud/v1/chat/events \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <x-bot-id>'

200

{
  "events": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "payload": {},
      "status": "pending",
      "failureReason": "<string>",
      "conversationId": "<string>",
      "userId": "<string>",
      "messageId": "<string>"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

Query Parameters

nextToken · string

Provide the meta.nextToken value provided in the last API response to retrieve the next page of results

type · string

Filter by event type

conversationId · string

Filter by conversation id

userId · string

Filter by user id

messageId · string

Filter by message id

workflowId · string

Filter by workflow id

status · enum<string>

Filter by status. Allowed values: pending, ignored, processed, failed.

Available options: pending, ignored, processed, failed, scheduled

Response

200

application/json

Returns a list of Event objects

events · object[] · required

Show child attributes

events. id · string · required

Id of the Event

Required string length: 28 - 36

events. createdAt · string<date-time> · required

Creation date of the Event in ISO 8601 format

events. type · string · required

Type of the Event.

Maximum string length: 200

events. payload · object · required

Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our api.

events. status · enum<string> · required

Available options: pending, processed, ignored, failed, scheduled, canceled

events. failureReason · string | null · required

Reason why the event failed to be processed

Maximum string length: 2000

events. conversationId · string

ID of the Conversation to link the event to.

Required string length: 28 - 36

events. userId · string

ID of the User to link the event to.

Required string length: 28 - 36

events. messageId · string

ID of the Message to link the event to.

Required string length: 28 - 36

meta · object · required

Show child attributes

meta. nextToken · string

The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.