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
Recommended. This endpoint is part of the public
/v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.url, add or remove events, rotate the signing secret, or toggle is_active to temporarily pause delivery. 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.
When to use this
- URL change: your consumer service moved to a new host or path.
- Adding events: you started building a feature that needs an additional event type and want it delivered to the existing endpoint.
- Removing events: your consumer no longer cares about a particular event and you want to stop the unnecessary deliveries.
- 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
The public contract does not promise a dual-secret overlap window. Rotate as if the new value can take effect immediately:- 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.400 Bad Requestis returned when the URL is malformed or an event type is unknown.
Related endpoints
- List Webhooks: review every webhook on the workspace.
- Delete Webhook: permanently remove a subscription.
- Webhook secrets: verification format.
- Webhook retries and failures: how DialNexa handles delivery failures.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Webhook ID
Example:
"webhook_abc123"
Body
application/json
Update Webhook