Webhooks
Update a webhook
Update a webhook.
TypeScript SDKThe npm client, generated from the API spec.Python SDKThe PyPI client, sync and async.
| Method | Path |
|---|---|
| PUT | /v1/webhooks/{webhook_id} |
Changing its URL resets verification and approval and sends a new ping.
Path parameters
webhook_idstringrequired
curl -X PUT "https://api.ellipsis.dev/v1/webhooks/{webhook_id}" \
-H "Authorization: Bearer $ELLIPSIS_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/ellipsis",
"events": [
"session.create"
]
}'import os
from ellipsis import Ellipsis
from ellipsis import models
client = Ellipsis(api_key=os.environ["ELLIPSIS_API_TOKEN"])
request = models.WebhookConfigRequest.model_validate(
{
"url": "https://example.com/ellipsis",
"events": [
"session.create"
]
}
)
result = client.webhooks.update(
"webhook_example",
request.events,
request.url,
)
print(result)import { Ellipsis } from '@ellipsis-dev/sdk';
const client = new Ellipsis({
apiKey: process.env.ELLIPSIS_API_TOKEN!,
});
const request: Parameters<typeof client.webhooks.update>[1] = {
"url": "https://example.com/ellipsis",
"events": [
"session.create"
]
};
const result = await client.webhooks.update("webhook_example", request);
console.log(result);Request
Example request body
{
"url": "https://example.com/ellipsis",
}
Body parameters
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
Example response, 200
{
}