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

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

Request body

Event data

typestringrequired
Type of the Event.(max length: 200)
payloadobjectrequired
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.
scheduleobject
Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.
conversationIdstring
ID of the Conversation to link the event to.(min length: 28, max length: 36)
userIdstring
ID of the User to link the event to.(min length: 28, max length: 36)
workflowIdstring
ID of the Workflow to link the event to.(min length: 28, max length: 36)
messageIdstring
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

eventobjectrequired
The event object represents an action or an occurrence.