Docs

createEvent

Creates a new Event. When creating a new Event, the required tags must be provided. See the specific integration for more details.

POST/v1/chat/events

Authorization

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

Header parameters

x-bp-authenticated-principalstring
Authenticated principal. Injected by the authentication middleware.
x-bot-idstring
Bot id
x-integration-id?string
Integration id
x-integration-alias?string
Integration alias

Request body

Event data

typestring
Type of the Event.(max length: 200)
payloadobject
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.
schedule?object
Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.
conversationId?string
ID of the Conversation to link the event to.(min length: 28, max length: 36)
userId?string
ID of the User to link the event to.(min length: 28, max length: 36)
workflowId?string
ID of the Workflow to link the event to.(min length: 28, max length: 36)
messageId?string
ID of the Message to link the event to.(min length: 28, max length: 36)

Response

Returns a Event object if creation succeeds. Returns an error otherwise

eventobject
The event object represents an action or an occurrence.