Skip to main content
PATCH
/
v1
/
webhook-subscriptions
/
{subscription_id}
Update a webhook subscription
curl --request PATCH \
  --url https://agents.assemblyai.com/v1/webhook-subscriptions/{subscription_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "events": [],
  "secret": "<string>",
  "enabled": true
}
'
{
  "id": "<string>",
  "agent_id": "<string>",
  "url": "<string>",
  "events": [],
  "enabled": true,
  "secret_version": 1,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Your AssemblyAI API key in the Authorization header (raw key; a Bearer prefix is also accepted).

Path Parameters

​
subscription_id
string
required
Example:

"0d75ebd7-937c-495c-b638-ba582ec05b39"

Body

application/json

All fields optional. A new secret rotates it and increments secret_version.

​
url
string
​
events
enum<string>[]
Available options:
session.started,
session.completed,
call.connected,
call.ended,
call.failed
​
secret
string
Required string length: 32 - 256
​
enabled
boolean

Response

The updated subscription.

A subscription. The signing secret is never returned, only its version.

​
id
string
​
agent_id
string | null
​
url
string
​
events
enum<string>[]
Available options:
session.started,
session.completed,
call.connected,
call.ended,
call.failed
​
enabled
boolean
​
secret_version
integer
Example:

1

​
created_at
string<date-time>
​
updated_at
string<date-time>