API Reference

Create a Webhook

POST/v1/webhooks

Creates a new webhook for this tenant.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_CREATE_STARTWEBHOOK_CREATE_SUCCESSWEBHOOK_CREATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The webhook payload

TypeScript Definitions

Use the request body type in TypeScript.

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": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

Retrieve all Webhooks

GET/v1/webhooks

Retrieves a list of webhooks configured on the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_RETRIEVE_LIST_STARTWEBHOOK_RETRIEVE_LIST_SUCCESSWEBHOOK_RETRIEVE_LIST_FAIL

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": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",      "events": [        "OpenIdCredentialIssued"      ],      "url": "https://example.com",      "disabled": false    },    {      "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",      "events": [        "OpenIdCredentialIssued"      ],      "url": "https://example.com",      "disabled": false    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjItMDgtMjJUMDElM0E1OSUzQTE5LjYyMFomaWQ9MGMwOTk2MTEtMTljNC00ZjI5LTg3MjQtNmI5ZTViYTFlZjdj"}

Retrieve a Webhook

GET/v1/webhooks/{webhookId}

Retrieve a specific Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_RETRIEVE_STARTWEBHOOK_RETRIEVE_SUCCESSWEBHOOK_RETRIEVE_FAIL

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/41458e5a-9092-40b7-9a26-d4eb43c5792f"

{  "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

Update a Webhook

PUT/v1/webhooks/{webhookId}

Updates an existing Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_UPDATE_STARTWEBHOOK_UPDATE_SUCCESSWEBHOOK_UPDATE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

Update Webhook

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X PUT "https://example.com/v1/webhooks/41458e5a-9092-40b7-9a26-d4eb43c5792f" \  -H "Content-Type: application/json" \  -d '{    "events": [      "OpenIdCredentialIssued"    ],    "url": "https://example.com"  }'

{  "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

Delete a Webhook

DELETE/v1/webhooks/{webhookId}

Deletes a Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_DELETE_STARTWEBHOOK_DELETE_SUCCESSWEBHOOK_DELETE_FAIL

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Retrieve Webhook JWKs

GET/v1/webhooks/jwks

Retrieves a list of Webhook JWKs (JSON Web Keys) from the tenant. These keys can be used to verify the HTTP signature and validate the integrity and authorship of generated Webhooks.

This endpoint is intended for public consumption, and as such does not require authentication.

Response Body

`application/json`

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

{  "keys": [    {      "kty": "OKP",      "crv": "Ed25519",      "x": "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo",      "use": "sig",      "kid": "FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ"    }  ]}

Create a Webhook

POST/v1/webhooks

Creates a new webhook for this tenant.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_CREATE_STARTWEBHOOK_CREATE_SUCCESSWEBHOOK_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": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

Retrieve all Webhooks

GET/v1/webhooks

Retrieves a list of webhooks configured on the tenant.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_RETRIEVE_LIST_STARTWEBHOOK_RETRIEVE_LIST_SUCCESSWEBHOOK_RETRIEVE_LIST_FAIL

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": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",      "events": [        "OpenIdCredentialIssued"      ],      "url": "https://example.com",      "disabled": false    },    {      "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",      "events": [        "OpenIdCredentialIssued"      ],      "url": "https://example.com",      "disabled": false    }  ],  "nextCursor": "Y3JlYXRlZEF0PTIwMjItMDgtMjJUMDElM0E1OSUzQTE5LjYyMFomaWQ9MGMwOTk2MTEtMTljNC00ZjI5LTg3MjQtNmI5ZTViYTFlZjdj"}

Retrieve a Webhook

GET/v1/webhooks/{webhookId}

Retrieve a specific Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_RETRIEVE_STARTWEBHOOK_RETRIEVE_SUCCESSWEBHOOK_RETRIEVE_FAIL

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/41458e5a-9092-40b7-9a26-d4eb43c5792f"

{  "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

Update a Webhook

PUT/v1/webhooks/{webhookId}

Updates an existing Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_UPDATE_STARTWEBHOOK_UPDATE_SUCCESSWEBHOOK_UPDATE_FAIL

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/41458e5a-9092-40b7-9a26-d4eb43c5792f" \  -H "Content-Type: application/json" \  -d '{    "events": [      "OpenIdCredentialIssued"    ],    "url": "https://example.com"  }'

{  "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",  "events": [    "OpenIdCredentialIssued"  ],  "url": "https://example.com",  "disabled": false}

Delete a Webhook

DELETE/v1/webhooks/{webhookId}

Deletes a Webhook by providing its ID.

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_DELETE_STARTWEBHOOK_DELETE_SUCCESSWEBHOOK_DELETE_FAIL

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/41458e5a-9092-40b7-9a26-d4eb43c5792f"

Empty

Retrieve Webhook JWKs

GET/v1/webhooks/jwks

Retrieves a list of Webhook JWKs (JSON Web Keys) from the tenant. These keys can be used to verify the HTTP signature and validate the integrity and authorship of generated Webhooks.

This endpoint is intended for public consumption, and as such does not require authentication.

Response Body

`application/json`

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

{  "keys": [    {      "kty": "OKP",      "crv": "Ed25519",      "x": "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo",      "use": "sig",      "kid": "FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ"    }  ]}

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

204

400application/json

404application/json

200application/json

On this page

API Reference

Roles

Analytics Events

201application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

Roles

Analytics Events

200application/json

400application/json

404application/json

Roles

Analytics Events

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`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`