Webhooks
Update a webhook
PUT /v1/webhooks/{webhook_id}- Permission
write:webhooks- Tokens
- API key, CLI user token
Update a webhook. Changing its URL resets verification and approval and sends a new ping.
Path parameters
webhook_idstringrequired
{
"description": str,
"url": str
}
{
}
1
import os
2
3
from ellipsis import Ellipsis
4
from ellipsis import models
5
6
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
7
8
request = models.WebhookConfigRequest.model_validate(
9
{
10
"url": "https://example.com/ellipsis",
11
"events": [
12
"session.create"
13
]
14
}
15
)
16
17
result = client.webhooks.update(
18
"webhook_example",
19
request.events,
20
request.url,
21
)
22
print(result)
1
import { Ellipsis } from '@ellipsis-dev/sdk';
2
3
const client = new Ellipsis({
4
apiKey: process.env.ELLIPSIS_API_TOKEN!,
5
});
6
7
const request: Parameters<typeof client.webhooks.update>[1] = {
8
"url": "https://example.com/ellipsis",
9
"events": [
10
"session.create"
11
]
12
};
13
14
const result = await client.webhooks.update("webhook_example", request);
15
console.log(result);
1
curl -X PUT "https://api.ellipsis.dev/v1/webhooks/{webhook_id}" \
2
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN" \
3
-H "Content-Type: application/json" \
4
-d '{
5
"url": "https://example.com/ellipsis",
6
"events": [
7
"session.create"
8
]
9
}'
Request
descriptionstring
eventsarray<string>required
Explicit event subscriptions. Currently only session.create is supported. Pings are sent independently of subscriptions.
urlstringrequired
The single public HTTPS URL to receive signed POST requests. Changing it requires verification and approval again.
Response
webhookWebhookrequired