API Reference

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}

Retrieve all Webhooks

GET/v1/webhooks

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Range1 <= value <= 1000

Default100

cursor?string

Starting point for the list of entries.

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhooks"

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

Retrieve a Webhook

GET/v1/webhooks/{webhookId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

webhookId*string

The requested Webhook ID.

Formatuuid

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"

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

Update a Webhook

PUT/v1/webhooks/{webhookId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

webhookId*string

Webhook ID

Formatuuid

Request Body

application/json

Update Webhook

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

Response Body

`application/json`

curl -X PUT "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "events": [      "OpenIdCredentialIssued"    ],    "url": "http://example.com"  }'

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

Delete a Webhook

DELETE/v1/webhooks/{webhookId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

webhookId*string

Webhook ID

Formatuuid

Response Body

`application/json`

curl -X DELETE "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"

Empty

Retrieve Webhook JWKs

GET/v1/webhooks/jwks

Response Body

`application/json`

curl -X GET "https://example.com/v1/webhooks/jwks"

{  "keys": [    {      "kty": "string",      "crv": "string",      "x": "string",      "use": "string",      "kid": "string"    }  ]}

Create a Webhook

Authorization

Request Body

Response Body

`application/json`

`application/json`

Retrieve all Webhooks

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

Retrieve a Webhook

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Update a Webhook

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/json`

Delete a Webhook

Authorization

Path Parameters

Response Body

`application/json`

`application/json`

Retrieve Webhook JWKs

Response Body

`application/json`

On this page

API Reference

201application/json

400application/json

200application/json

400application/json

200application/json

400application/json

200application/json

400application/json

404application/json

204

400application/json

404application/json

200application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`