v45

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0114775543.6 KB

Webhooks

Update a webhook

Update a webhook's endpoint URL, description, or custom headers. At least one of the three fields must be present in the request body.

Event subscriptions cannot be changed here. To add or remove an agent's subscription to this webhook, use POST /agent/{agentId}/webhook-subscriptions and DELETE /agent/{agentId}/webhook-subscriptions.

Custom headers behavior

Send a non-empty object to replace all custom headers on the webhook.
Send an empty object ({}) to clear all custom headers.
Omit the field to leave existing custom headers untouched.

Custom header limits: at most 10 headers per webhook, values up to 1024 characters, header names must match RFC 7230 token syntax. The following names are reserved and rejected: x-signature, host, content-length, content-type, connection, transfer-encoding.

patch/webhook/{id}

Path parameters

idstring required

The ID of the webhook to update.

Request body

endpointstring uri

New endpoint URL. Must be a valid URL.

descriptionstring

New human-readable label.

headersobject

Map of custom header names to values. Non-empty object replaces all existing headers; empty object clears them.

Example request

{
  "endpoint": "https://example.com/webhook",
  "description": "Debt Collection Agent's Endpoint",
  "headers": {
    "x-api-key": "your-gateway-key"
  }
}

Response

Webhook updated successfully.

statusboolean

datastring

The ID of the updated webhook.

Example response

{
  "status": true,
  "data": "60d0fe4f5311236168a109ca"
}