Skip to main content
Webhook

Read webhook event types

GET/v4/config/platform/webhooks/event-types

Lists the event types that a webhook of your organisation can subscribe to, sorted by type, with what it means, the version of its body and its product feature. Put each type in the matching group of subscribedEvents when you create or update a webhook: the ows.* types in digitalWalletWebhook, the consent.* and data.* types in consentManagementWebhook, and datamarketplace.data_disclosure_agreement_record in dataMarketplaceWebhook.

Each event type has one product feature: issuerVerifier for the ows.issuer.* and ows.verifier.* types, walletUnit for the ows.holder.* types, consentManagement for the consent.* and data.* types, and dataDisclosureAgreements for the datamarketplace.* type. The list has only the types of the effective features of your organisation: the platform admin turned the feature on, and each service that the feature needs is installed (see Read organisation features). A sandbox organisation has the features of its main organisation. Your organisation gets no events of a type whose feature is off, also when a webhook subscribes to it.

Authorizations

  • Authorizationstringheaderrequired

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

    Scope:webhooks:read

Response

application/json

The event types that the organisation can subscribe to.

  • eventTypesobject[]

    The event types of the effective features of the organisation, sorted by type.