List all webhooks

GET 
/v2/config/webhooks

This endpoint lists all the webhooks of the organisation. Each item in the list also gives the result of the last payload delivery to the webhook. The server does not list deleted webhooks. Use the offset and limit query parameters to page through the list.

The newest webhook comes first. The server replaces an offset that is less than 0 and a limit that is 0 or less with the default value.

Each item holds the secret key of the webhook in clear text.

Request

Query Parameters

offset integerrequired

Default value: 0

Number of records to skip for pagination. A negative or unreadable value falls back to 0.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

Header Parameters

X-SandboxOrgId stringrequired
Optional. Unique identifier of the sandbox organisation to use for this request. When you send this header, the service runs the operation in the context of the named sandbox organisation, that is, against the wallet of that sandbox organisation and not against the main wallet of the organisation. Leave the header out to use the main wallet.
The service reads this header only when you authenticate with a bearer access token. When you authenticate with an API key, the service takes the sandbox organisation from the API key and ignores this header. To run an API-key call in a sandbox organisation, bind the key to the sandbox organisation with PUT /v2/config/admin/apikey/{apiKeyId}/sandbox-org instead.
X-SubwalletId is the deprecated name of this header. The service continues to accept it, but X-SandboxOrgId wins if you send both headers.
The sandbox organisation must exist, must belong to your organisation and must be deployed. An unknown identifier, an identifier of a sandbox organisation that is not deployed, and an identifier that belongs to a different organisation all make the call fail with HTTP 400.
Example: 6889e1a4c5b2f30001a3d710

Responses

200

OK

Response Headers

application/json

Schema

Schema

pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

webhooks object[]required

The webhooks on the requested page.

Example (from schema)

{
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  },
  "webhooks": [
    {
      "id": "68a1f2c3d4e5f6a7b8c9d0e1",
      "orgId": "string",
      "sandboxOrgId": "string",
      "payloadUrl": "https://example.com/hooks/igrant",
      "contentType": "application/json",
      "subscribedEvents": {
        "consentManagementWebhook": [
          "data.update.initiated"
        ],
        "digitalWalletWebhook": [
          "digitalwallet.connection.init"
        ],
        "dataMarketplaceWebhook": [
          "datamarketplace.data_disclosure_agreement_record"
        ]
      },
      "disabled": true,
      "secretKey": "string",
      "skipSslVerification": true,
      "timestamp": "2026-08-09T10:11:12Z",
      "isLastDeliverySuccess": true
    }
  ]
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...