Chat API
- Introduction
- Endpoints
Admin API
- Getting started
- Concepts
- Endpoints
Files API
Tables API
- Getting Started
- Endpoints
Runtime API
- Getting Started
- Concepts
- Endpoints
- POSTcreateConversation
- GETlistConversations
- GETgetConversation
- PUTupdateConversation
- DELdeleteConversation
- POSTgetOrCreateConversation
- GETlistParticipants
- POSTaddParticipant
- GETgetParticipant
- DELremoveParticipant
- POSTcreateEvent
- GETlistEvents
- GETgetEvent
- POSTcreateMessage
- GETlistMessages
- POSTgetOrCreateMessage
- GETgetMessage
- PUTupdateMessage
- DELdeleteMessage
- POSTcreateUser
- GETlistUsers
- GETgetUser
- PUTupdateUser
- DELdeleteUser
- POSTgetOrCreateUser
- POSTsetStateExpiry
- GETgetState
- POSTsetState
- PATCHpatchState
- POSTgetOrSetState
- POSTcallAction
- POSTconfigureIntegration
- GETlistTagValues
- POST
getEvent
Retrieves the Event object for a valid identifiers.
GET
/
v1
/
chat
/
events
/
{id}
curl --request GET \
--url https://api.botpress.cloud/v1/chat/events/{id}
{
"event": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"type": "<string>",
"payload": {},
"conversationId": "<string>",
"userId": "<string>",
"messageId": "<string>",
"status": "pending",
"failureReason": "<string>"
}
}
Path Parameters
Event id
Response
200
application/json
Returns the [Event](#schema_event) object if a valid identifiers were provided. Returns [an error](#errors) otherwise
The event object represents an action or an occurrence.
Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our api.
Available options:
pending
, processed
, ignored
, failed
, scheduled
Reason why the event failed to be processed
Maximum length:
2000
ID of the Conversation to link the event to.
Required string length:
28 - 36
Was this page helpful?
curl --request GET \
--url https://api.botpress.cloud/v1/chat/events/{id}
{
"event": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"type": "<string>",
"payload": {},
"conversationId": "<string>",
"userId": "<string>",
"messageId": "<string>",
"status": "pending",
"failureReason": "<string>"
}
}