GET
/
v1
/
chat
/
events
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/events
{
  "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>"
  }
}

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](#schema_event) objects
​
events
object[]
required

The event object represents an action or an occurrence.

​
meta
object
required

Was this page helpful?

Suggest editsRaise issue