Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

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

Body

application/json

Input for creating a webhook

url
string<uri>
required

Webhook URL

events
enum<string>[]
required

Event types to subscribe to (at least one required)

Minimum array length: 1
Available options:
CALL_ANALYSIS_COMPLETED,
CALL_ANALYSIS_FAILED,
CALL_ANALYSIS_CANCELLED,
CALL_EVALUATION_COMPLETED,
CALL_EVALUATION_FAILED,
SIMULATION_RUN_PLAN_JOB_STARTED,
SIMULATION_RUN_PLAN_JOB_COMPLETED,
SIMULATION_RUN_PLAN_JOB_FAILED,
SIMULATION_RUN_PLAN_JOB_CANCELLED,
SIMULATION_JOB_STARTED,
SIMULATION_JOB_COMPLETED,
SIMULATION_JOB_FAILED,
SIMULATION_JOB_CANCELLED,
METRIC_COLLECTION_JOB_COMPLETED,
METRIC_COLLECTION_JOB_FAILED,
CHAT_ANALYSIS_COMPLETED,
CHAT_ANALYSIS_FAILED,
ISSUE_OPENED,
ISSUE_RESOLVED
description
string | null

Webhook description

headers
object

Request headers (e.g. authorization tokens)

Response

The created webhook with signing secret

data
object
required

Webhook response with signing secret (returned on creation)