getEvent

Retrieves the Event object for a valid identifiers.

GET /v1/chat/events/{id}

cURL

cURL

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

200

{
  "event": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "type": "<string>",
    "payload": {},
    "failureReason": "<string>",
    "conversationId": "<string>",
    "userId": "<string>",
    "messageId": "<string>"
  }
}

Authorizations

Authorization · string · header · required

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

Headers

x-bp-authenticated-principal · string · required

Authenticated principal. Injected by the authentication middleware.

x-bot-id · string · required

Bot id

x-integration-id · string

Integration id

x-integration-alias · string

Integration alias

x-real-ip · string

Caller's IP address. Injected by the edge proxy.

Path Parameters

id · string · required

Event id

Response

200

application/json

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.

Show child attributes