Update a webhook
Change an outbound webhook: which events it receives (events REPLACES the list, so read list_workspace_webhooks first and send the full set you want), pause or resume it (isActive), its https URL, or its label. Pass only what you want to change. Event keys: conversation.started, conversation.ended, call_log.completed, lead.received, lead.updated, campaign.launched, campaign.scheduled, campaign.paused, campaign.resumed, campaign.completed, campaign.cancelled, campaign.recipient.finished, alert.fired, metric.optimised. Changing the URL sends every future delivery, call details included, to the new address. Requires workspace-admin.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://example.com/workspaces/string/webhooks/string" \ -H "Content-Type: application/json" \ -d '{}'{
"webhook": {
"id": "string",
"endpointUrl": "string",
"events": [
"string"
],
"isActive": true,
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Replace a webhook's signing secret POST
Replace a webhook's signing secret with a new one and return it once. The old secret stops working immediately, so the receiving system rejects deliveries until it is given the new secret: only do this when the user asks, for example after a leak. Deliveries are signed HMAC-SHA256 in X-VAI-Signature. Destructive, needs confirm: true. Requires workspace-admin.
A workspace alert fired. Webhook
Next Page