List all webhooks

GET 
/v2/config/webhooks

This endpoint is used to get all webhooks that was defined to trigger events to an external IT system.

Request

Query Parameters

offset integerrequired

Number of records to skip for pagination.

limit integerrequired

Default value: 10

Maximum number of records to return per page.

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[]
Array [
oneOf
Webhook
id string
Webhook ID
orgId string
Organisation ID
payloadUrl stringrequired
Webhook payload Url
contentType stringrequired
Possible values: [application/json, application/x-www-form-urlencoded]
Webhook payload content type
subscribedEvents objectrequired
consentManagementWebhook string[]
Possible values: [data.update.initiated, data.update.cancelled, consent.allowed, consent.disallowed, consent.auto_expiry, org.unsubscribed, data.delete.initiated, data.download.initiated, data.delete.cancelled, data.download.cancelled, org.subscribed]
digitalWalletWebhook string[]
Possible values: [digitalwallet.connection.init, digitalwallet.connection.invitation, digitalwallet.connection.request, digitalwallet.connection.response, digitalwallet.connection.active, digitalwallet.connection.error, digitalwallet.connection.inactive, digitalwallet.connection.delete, digitalwallet.credential.proposal_sent, digitalwallet.credential.proposal_received, digitalwallet.credential.offer_sent, digitalwallet.credential.offer_received, digitalwallet.credential.request_sent, digitalwallet.credential.request_received, digitalwallet.credential.credential_issued, digitalwallet.credential.credential_received, digitalwallet.credential.credential_acked, digitalwallet.presentation.proposal_sent, digitalwallet.presentation.proposal_received, digitalwallet.presentation.request_sent, digitalwallet.presentation.request_received, digitalwallet.presentation.presentation_sent, digitalwallet.presentation.presentation_received, digitalwallet.presentation.verified, digitalwallet.presentation.presentation_acked, openid.credential.offer_sent, openid.credential.offer_received, openid.credential.credential_issued, openid.credential.credential_acked, openid.credential.credential_pending, openid.presentation.request_sent.v3, openid.presentation.request_received.v3, openid.presentation.presentation_acked.v3, openid.presentation.presentation_pending.v3]
dataMarketplaceWebhook string[]
Possible values: [datamarketplace.data_disclosure_agreement_record]
disabled booleanrequired
Is webhook disabled or not
secretKey stringrequired
Secret key for checking authenticity of the source
skipSslVerification booleanrequired
Skip SSL verification for webhook Url
timestamp stringrequired
Creation timestamp
]

Example (from schema)

{
  "pagination": {
    "currentPage": 1,
    "totalItems": 25,
    "totalPages": 3,
    "limit": 10,
    "hasPrevious": false,
    "hasNext": true
  },
  "webhooks": [
    {}
  ]
}

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...