POST
/
webhooks
curl --request POST \
  --url https://api.prod.usesimple.ai/api/v1/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "url": "<string>",
  "event_types": [
    "call.started"
  ],
  "description": "<string>",
  "disabled": false,
  "rate_limit": 123
}'
{
  "endpoint_id": "<string>",
  "url": "<string>",
  "event_types": [
    "call.started"
  ],
  "description": "<string>",
  "disabled": true,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
url
string
required

The URL where webhook events will be sent

​
event_types
enum<string>[]

The types of events to subscribe to. If not specified, all event types will be included.

Available options:
call.started,
call.completed,
transcript.updated
​
description
string

Optional description for the webhook endpoint

​
disabled
boolean
default:false

Whether the webhook is initially disabled

​
rate_limit
integer

Optional rate limit for the webhook (requests per minute)

Response

201
application/json
Webhook Created Successfully
​
endpoint_id
string
required

Unique identifier for the webhook endpoint

​
url
string
required

The URL where webhook events will be sent

​
event_types
enum<string>[]
required

The types of events the webhook is subscribed to

Available options:
call.started,
call.completed,
transcript.updated
​
created_at
string
required

When the webhook endpoint was created

​
description
string

Description of the webhook endpoint

​
disabled
boolean

Whether the webhook is disabled

Was this page helpful?