Skip to main content
GET
/
v1
/
chat
/
events
/
{id}
cURL
curl --request GET \
  --url https://api.botpress.cloud/v1/chat/events/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-bot-id: <api-key>'
{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>",
    "status": "pending",
    "failureReason": "<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.

Path Parameters

​
id
string
required

Event id

Response

Returns the Event object if a valid identifiers were provided. Returns an error otherwise

​
event
object
required

The event object represents an action or an occurrence.