Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Your organization's API key (sk_cont_...), sent as Authorization: Bearer sk_cont_.... Keep it server-side.

Body

application/json
events
string[]
required

Which events to receive. Any subset of call.started, call.ended, call.analyzed.

url
string
required

HTTPS URL we POST events to. Must be publicly reachable; private and loopback addresses are rejected.

agent_ids
string<uuid>[] | null

Only deliver events for calls made by these agents. Omit (or send null) to receive events for every call in your organization, including calls started from the Contour dashboard.

description
string | null

A label for your own reference.

Maximum string length: 500

Response

Successful Response

Returned by create and rotate-secret only. secret is shown once.

created_at
string<date-time>
required
enabled
boolean
required

False while deliveries are paused.

events
string[]
required

Subscribed events.

id
string<uuid>
required

Endpoint id; use it in every other endpoint call.

secret
string
required

The signing secret (whsec_...). Shown in this response only; store it in your webhook handler's configuration.

secret_hint
string
required

The last four characters of the signing secret, so you can tell which secret an endpoint is using without exposing it.

updated_at
string<date-time>
required
url
string
required

Where events are delivered.

agent_ids
string<uuid>[] | null

Agent filter, or null for all calls in the organization.

description
string | null

Your label.