Create Webhook

POST/v1/webhooks

Creates a new webhook for this tenant.

Analytic events

WEBHOOK_CREATE_START
WEBHOOK_CREATE_SUCCESS
WEBHOOK_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The webhook payload

TypeScript Definitions

Use the request body type in TypeScript.

events*array<>

This array includes the event types that will trigger this Webhook. The following events are currently supported:

OpenIdCredentialIssued: Triggered upon completion of an OID4VCI issuance flow and includes credential data.
OpenIdCredentialIssuedSummary: Triggered upon completion of an OID4VCI issuance flow but does not include credential data.

url*string

This is the URL that will receive the Webhook events data payload when they are triggered by MATTR VII for the specified events:

Must be a valid URL.
Must use the HTTPS protocol.
Must not be an IP address.
Must not include query parameters or have fragments.
Non-ASCII characters are normalized.
Must return a 2xx response, otherwise it will go through a retry cycle and eventually fail.

Formaturi

disabled?boolean

Indicates whether or not the Webhook is disabled. When set to true the webhook is disabled, and notifications for events associated with it will not be sent. If no value is provided, defaults to false.

Response Body

`application/json`

curl -X POST "https://example.com/v1/webhooks" \  -H "Content-Type: application/json" \  -d '{    "events": [      "OpenIdCredentialIssued"    ],    "url": "https://example.com"  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "events": [    "string"  ],  "url": "http://example.com",  "disabled": false}

Roles

Analytics Events

Analytic events

Authorization

Request Body

Response Body

`application/json`

`application/json`

Create Webhook

Roles

Analytics Events

Analytic events

Authorization

Request Body

Response Body

201application/json

400application/json

`application/json`

`application/json`