Webhook

Update webhook

PUT/v4/config/platform/webhook/{webhookId}

Replaces the settings of a webhook: the payload URL, the content type, the subscribed event types, the disabled flag, the secret key and the TLS check flag. Use it to change the event types, to rotate the secret key, or to pause the webhook with disabled.

This is a full replacement, not a partial update: send every field on every call. A field that you leave out gets its default (for subscribedEvents, a missing group is empty). The rules of Create webhook apply: at least 1 event type, and a payload URL that no other webhook of the organisation (or sandbox organisation) has.

The id, orgId, sandboxOrgId and timestamp of the webhook do not change. A new secret key signs the next attempt, also of a delivery that is in progress.

Update webhook

Language of the request sample

curl -X PUT 'https://demo-api.igrant.io/v4/config/platform/webhook/68a1f2c3d4e5f6a7b8c9d0e1' \
  -H 'Authorization: ApiKey <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook": {
    "payloadUrl": "https://example.com/webhooks/igrant",
    "contentType": "application/json",
    "subscribedEvents": {
      "digitalWalletWebhook": [
        "ows.issuer.issuance_history.credential_issued",
        "ows.verifier.verification.presentation_received",
        "ows.holder.credential.received"
      ]
    },
    "disabled": false,
    "secretKey": "<webhook-secret-key>",
    "skipSslVerification": false
  }
}'

{
  "webhook": {
    "id": "6af08b9f38e8f33dcf79965f",
    "orgId": "6ae2bf741c3dadfeb27982ec",
    "payloadUrl": "https://example.com/webhooks/igrant",
    "contentType": "application/json",
    "subscribedEvents": {
      "consentManagementWebhook": [],
      "digitalWalletWebhook": [
        "ows.issuer.issuance_history.credential_issued",
        "ows.verifier.verification.presentation_received",
        "ows.holder.credential.received"
      ],
      "dataMarketplaceWebhook": []
    },
    "disabled": false,
    "secretKey": "<webhook-secret-key>",
    "skipSslVerification": false,
    "timestamp": "2026-11-08T14:47:59Z"
  }
}

Authorizations

Authorizationstringheaderrequired
Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.
Scope:webhooks:update

Path parameters

webhookIdstringrequired
The id of the webhook, from Create webhook or List all webhooks.
Example:"68a1f2c3d4e5f6a7b8c9d0e1"

Body

application/json

The new settings of the webhook.

webhookobjectrequired
The new settings of the webhook.

Response

application/json

The webhook after the update.

webhookobject
The webhook after the update.