Register for notifications via webhook. See the 'Webhook Handlers' section for what you will need to implement as a webhook consumer.
Call Events
Register for notifications about Call events.
Request Body
eventTypestringEvents to register for. Pipe delimited list, single value, or * for all events.
authTokenstringAuthToken that will be sent to the handler with all payloads in the HTTP Authorization header.
targetUrlstringURL to send the AuthToken and payload to for matching events.
Responses
Indicates successful registration for the webhook.
webhookIdstringUnique ID for this webhook registration.
errorbooleanTrue if the registration failed, false otherwise.
errorMessagestringDetails about registration failure, or empty if no error.
CAD Integration Events
Register for notifications related to Assist's CAD integration.
Request Body
eventTypestringEvents to register for. Pipe delimited list, single value, or * for all events.
authTokenstringAuthToken that will be sent to the handler with all payloads in the HTTP Authorization header.
targetUrlstringURL to send the AuthToken and payload to for matching events.
Responses
Indicates successful registration for the webhook.
webhookIdstringUnique ID for this webhook registration.
errorbooleanTrue if the registration failed, false otherwise.
errorMessagestringDetails about registration failure, or empty if no error.
Assistant Events
Register for notifications about Assistant events.
Request Body
eventTypestringEvents to register for. Pipe delimited list, single value, or * for all events.
authTokenstringAuthToken that will be sent to the handler with all payloads in the HTTP Authorization header.
targetUrlstringURL to send the AuthToken and payload to for matching events.
Responses
Indicates successful registration for the webhook.
webhookIdstringUnique ID for this webhook registration.
errorbooleanTrue if the registration failed, false otherwise.
errorMessagestringDetails about registration failure, or empty if no error.