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

Authorization

AuthorizationBearerrequired

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

Header parameters

x-bot-idstringrequired

Bot id

x-integration-idstring

Integration id

x-integration-aliasstring

Integration alias

Query parameters

nextTokenstring

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

typestring

Filter by event type

conversationIdstring

Filter by conversation id

userIdstring

Filter by user id

messageIdstring

Filter by message id

workflowIdstring

Filter by workflow id

statusenum<string>

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

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

Response

Returns a list of Event objects

eventsobject[]required

metaobjectrequired

Request

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

Response

{
  "events": [
    {
      "id": "string",
      "createdAt": "2025-01-15T12:00:00Z",
      "type": "string",
      "payload": {},
      "conversationId": "string",
      "userId": "string",
      "messageId": "string",
      "status": "pending",
      "failureReason": "string"
    }
  ],
  "meta": {
    "nextToken": "string"
  }
}