Webhooks

Update Webhook

Updates the URL, events, active flag, or signing secret. Only the fields you send change. The response masks the secret as ********. A new secret signs the next delivery; there is no overlap window.

patch/v1/user-webhooks/{id}

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/user-webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required
Example:webhook_c9v3nz8rq4pmxa

Webhook ID with the webhook_ prefix, as returned by Create Webhook.

Request body

urlstring uri

The new URL for the webhook.

eventsstring[]

Updated list of events.

is_activeboolean

Whether the webhook is active.

secretstring

New secret for signing payloads.

Example request

{
  "url": "https://webhook.site/updated-endpoint",
  "events": [
    "call.completed"
  ],
  "secret": "replace-with-a-new-long-random-secret"
}

Response

Webhook updated successfully.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "message": "Webhook updated successfully",
    "webhook": {
      "id": "webhook_c9v3nz8rq4pmxa",
      "org_id": "o14XKPP84rt22g",
      "url": "https://example.com/dialnexa/webhook",
      "events": [
        "call.completed"
      ],
      "is_active": true,
      "secret": "********"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.