Sign in

v8

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-05730512.7 KB
Webhooks

Update a webhook endpoint

Update a webhook endpoint's label, url, subscribed_events, or enabled flag. Send rotate_secret: true to generate a new signing secret — the new secret is returned in full in that response only. Send only the fields you want to change.

patch/v1/webhooks/{uuid}

Path parameters

uuidstring uuid required

UUID of the webhook endpoint to update.

Request body

labelstring

You optionally set the endpoint label.

urlstring uri

You optionally set the destination URL.

subscribed_eventsstring[]

You optionally replace the subscribed event types.

enabledboolean

You optionally enable or disable the endpoint.

rotate_secretboolean

You optionally rotate the signing secret. When true, the response returns the new secret in full.

Example request

{
  "label": "Production events",
  "url": "https://api.acme.example/webhooks/didit",
  "subscribed_events": [
    "credential.revoked"
  ],
  "enabled": true
}

Response

The webhook endpoint was updated. The secret is returned in full only when rotate_secret was true, otherwise it is masked.

idstring uuid

You receive the UUID for this webhook endpoint.

labelstring

You receive the endpoint label.

urlstring uri

You receive the destination URL that receives POST deliveries.

secretstring

You receive the masked signing secret (only the last 4 characters are shown).

subscribed_eventsstring[]

You receive the event types this endpoint is subscribed to. An empty array means all event types are delivered.

enabledboolean

You receive true when the endpoint is active and receiving deliveries.

created_atstring date-time

You receive the timestamp when the endpoint was created.

updated_atstring date-time

You receive the timestamp when the endpoint was last updated.

Example response

{
  "id": "b8f0f4a2-2b1e-4b3a-9d0e-4a1c2d3e4f50",
  "label": "Production events",
  "url": "https://api.acme.example/webhooks/didit",
  "secret": "********s9Zx",
  "subscribed_events": [
    "credential.issued",
    "presentation.verified"
  ],
  "enabled": true,
  "created_at": "2026-07-02T23:51:58.746686+00:00",
  "updated_at": "2026-07-02T23:51:58.746686+00:00"
}