Skip to main content
PATCH
Update a user webhook
Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. Use the /v1 version for new integrations. This endpoint remains available for existing integrations until then.
Updates a registered webhook subscription. You can change the delivery 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_active to false, then back to true later. If you do not plan to re-enable, use Delete Webhook instead.

Rotating the signing secret

When you pass a new secret value, DialNexa starts signing with the new secret on the very next delivery. There is no overlap period during which both the old and new secrets are accepted. To rotate safely:
  1. Update your consumer service to accept both the old and new secret during a transition window.
  2. Send the new secret to DialNexa through this endpoint.
  3. Confirm new deliveries are being verified with the new secret.
  4. Remove the old secret from your consumer service.
See Webhook secrets for the verification format and helper code.

Path parameters

Errors

  • 404 Not Found is returned when the webhook does not exist.
  • 400 Bad Request is returned when the URL is malformed or an event type is unknown.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-organization-id
string
required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Path Parameters

id
string
required

The ID of the webhook.

Example:

"wh_123"

Body

application/json
url
string

The new URL for the webhook.

Example:

"https://webhook.site/updated-endpoint"

events
string[]

Updated list of events.

Example:
is_active
boolean

Whether the webhook is active.

Example:

false

secret
string

New secret for signing payloads.

Example:

"newSecret"

Response

200 - undefined