cURL
curl --request POST \ --url https://api.botpress.cloud/v1/chat/events \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'x-bot-id: <api-key>' \ --data '{ "type": "<string>", "payload": {}, "schedule": { "dateTime": "<string>", "delay": 123 }, "conversationId": "<string>", "userId": "<string>", "messageId": "<string>" }'
{ "event": { "id": "<string>", "createdAt": "2023-11-07T05:31:56Z", "type": "<string>", "payload": {}, "conversationId": "<string>", "userId": "<string>", "messageId": "<string>", "status": "pending", "failureReason": "<string>" } }
Creates a new Event. When creating a new Event, the required tags must be provided. See the specific integration for more details.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Your bot ID.
Event data
The body is of type object.
object
Returns a Event object if creation succeeds. Returns an error otherwise
The response is of type object.
Was this page helpful?