Sign in

v11

OpenAPI 3.1.02026-08-0364112112.3 KB
Custom Events

Create a new custom event

Create a new custom event

post/v1/events

Request body

sourcestring
iconstring nullable
objectType'CONVERSATION' | 'ACCOUNT' | 'CUSTOMER' | 'USER' | 'CANNED_RESPONSE' | 'CHATBOT' | 'COMPANY' | 'CUSTOM_EVENTS' | 'HELPCENTER' | 'LINEAR' | 'JIRA' | 'SLACK' | 'SENTRY' | 'SESSION_RECORDING'
objectIdstring required
namestring required
descriptionstring nullable
payloadobject nullable
createdAtstring date-time nullable

Response

Successful Response

updatedAtstring date-time nullable
createdAtstring date-time nullable
iconstring nullable
objectType'CONVERSATION' | 'ACCOUNT' | 'CUSTOMER' | 'USER' | 'CANNED_RESPONSE' | 'CHATBOT' | 'COMPANY' | 'CUSTOM_EVENTS' | 'HELPCENTER' | 'LINEAR' | 'JIRA' | 'SLACK' | 'SENTRY' | 'SESSION_RECORDING'
objectIdstring required
namestring required
descriptionstring nullable
payloadobject nullable
idstring uuid required
processingStatus'PENDING' | 'SUCCESS' | 'INVALID' | 'LINKED' | 'FAILED' | 'UNPROCESSED' | 'UNKNOWN'