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

AuthorizationBearer

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

Header parameters

x-bp-authenticated-principalstring

Authenticated principal. Injected by the authentication middleware.

x-bot-idstring

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

pageSize?integer

Number of items to return per page (default 20, max 100)

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

Returns a list of Event objects

eventsobject[]

metaobject

Request

curl --request GET \ \
  --url https://api.botpress.cloud/v1/chat/events \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>' \
  --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"
  }
}