GET
/
v1
/
chat
/
events
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/events \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "events": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "type": "<string>",
      "payload": {},
      "conversationId": "<string>",
      "userId": "<string>",
      "messageId": "<string>",
      "status": "pending",
      "failureReason": "<string>"
    }
  ],
  "meta": {
    "nextToken": "<string>"
  }
}

Authorizations

Authorization
string
header
required

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

x-bot-id
string
header
required

Your bot ID.

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

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
meta
object
required