getEvent

Retrieves the Event object for a valid identifiers.

GET/v1/chat/events/{id}

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

Path parameters

idstringrequired

Event id

Response

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

eventobjectrequired

The event object represents an action or an occurrence.

Request

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

Response

{
  "event": {
    "id": "string",
    "createdAt": "2025-01-15T12:00:00Z",
    "type": "string",
    "payload": {},
    "conversationId": "string",
    "userId": "string",
    "messageId": "string",
    "status": "pending",
    "failureReason": "string"
  }
}