Read webhook event types

GET 
/v2/config/webhooks/event-types

This endpoint lists all the webhook event types that you can subscribe to. Use these values in the subscribedEvents field when you create or update a webhook. The list is the same for all organisations.

The order of the values in each array changes between calls. Do not depend on the order.

Responses

200

OK

Response Headers

application/json

Schema

Schema

consentManagementWebhookEventTypes consentManagementWebhookEventTypes[]required

Possible values: [consent.allowed, consent.auto_expiry, data.delete.initiated, data.update.initiated, data.download.cancelled, data.update.cancelled, data.download.initiated, data.delete.cancelled, consent.disallowed]

The event types for consent management. These events occur when an individual gives or refuses consent, or asks to delete, download or update their data.

dataMarketplaceWebhookEventTypes dataMarketplaceWebhookEventTypes[]required

Possible values: [datamarketplace.data_disclosure_agreement_record]

The event types for the data marketplace. These events occur when the server creates a data disclosure agreement record.

digitalWalletWebhookEventTypes digitalWalletWebhookEventTypes[]required

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_accepted, openid.credential.credential_deleted, openid.credential.issuance_denied, openid.credential.token_issued, openid.holder.credential.credential_pending, openid.holder.credential.credential_acked, openid.holder.credential.credential_accepted, openid.presentation.request_sent.v3, openid.presentation.request_received.v3, openid.presentation.presentation_acked.v3, openid.presentation.presentation_pending.v3]

The event types for the digital wallet. These events occur during a connection, a credential issuance or a credential verification. The list contains the DIDComm event types and the OpenID4VC event types.

Example (from schema)

{
  "consentManagementWebhookEventTypes": [
    "consent.allowed"
  ],
  "dataMarketplaceWebhookEventTypes": [
    "datamarketplace.data_disclosure_agreement_record"
  ],
  "digitalWalletWebhookEventTypes": [
    "digitalwallet.connection.init"
  ]
}

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