Webhooks
Update Webhook
Update a webhook endpoint.
PATCH
Update Webhook
Changes state - verify before retry
Updates a registered webhook subscription. You can change the delivery
url, replace the stored events list (it does not filter deliveries), rotate the signing secret, or toggle is_active to temporarily pause delivery (inactive subscriptions receive no deliveries). Only the fields you include are updated, omitted fields keep their current values. The subscription’s id does not change, so consumers can continue to reference the same webhook ID after the update. The response returns the updated subscription in data.webhook with the secret masked as ********. Changing the URL does not send a test request to it.
When to use this
- URL change: your consumer service moved to a new host or path.
- Changing events: the
eventslist is stored and returned as sent, but it does not filter deliveries today; every active subscription receives the call-ended delivery. See Available events. - Secret rotation: your signing secret leaked, expired, or you are on a periodic rotation cadence.
- Temporary pause: you want to stop receiving events without losing the subscription. Set
is_activetofalse, then back totruelater. If you do not plan to re-enable, use Delete Webhook instead.
Rotating the signing secret
Send a newsecret in this request. There is no dual-secret overlap window: the next delivery is signed with the new value.
- Update your consumer service to accept both the old and new secret during a transition window.
- Send the new secret to DialNexa through this endpoint.
- Confirm new deliveries are being verified with the new secret.
- Remove the old secret from your consumer service.
Path parameters
Errors
404 Not Foundis returned when the webhook does not exist in this workspace.400 Bad Requestis returned when the URL is malformed oreventsis empty.
Related endpoints
- List Webhooks: review every webhook on the workspace.
- Delete Webhook: permanently remove a subscription.
- Verifying the signature: verification format.
- Delivery behavior: deliveries are sent once and not retried.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Webhook ID with the webhook_ prefix, as returned by Create Webhook.
Example:
"webhook_c9v3nz8rq4pmxa"
Body
application/json
The new URL for the webhook.
Example:
"https://webhook.site/updated-endpoint"
Updated list of events.
Minimum array length:
1Example:
Whether the webhook is active.
Example:
false
New secret for signing payloads.
Example:
"replace-with-a-new-long-random-secret"