Skip to main content
POST
Create Endpoint

Request Body

string
required
The URL where webhook events will be delivered. Must use HTTPS.
array
required
Array of event types to subscribe to. Available events:
  • call.ended call has ended
  • call.analysis_ready post-call analysis is complete
  • call.completed contact reached terminal state
  • call.failed a call attempt failed
string
Optional human-readable description of the endpoint’s purpose.
string
Optional filter events to only those from a specific agent. If omitted, the endpoint receives events from all agents. See Webhook Filtering.

Response

boolean
Indicates if the endpoint was created successfully.
string
Unique identifier for the webhook endpoint. Use this for updates and deletion.
string
The HMAC secret used to verify webhook signatures. Store this securely it is only returned once.

Verifying Webhook Signatures

Use the returned secret to verify the x-oktivo-signature header on incoming webhooks:
The secret is only returned in this response. If you lose it, you’ll need to delete and recreate the endpoint.
This endpoint requires JWT authentication.