API Reference
Create a Webhook
Creates a new webhook for this tenant.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>The webhook payload
application/json- body
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*stringThis 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.
uridisabled?booleanIndicates 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.
Webhook created
application/json- response
id?stringUnique identifier for the created Webhook. You will need it to verify Webhook requests.
uuidevents?array<string>List of events that trigger the Webhook, as defined in the request.
url?stringThe URL that will receive the Webhook events data payload when they are triggered, as defined in the request.
uridisabled?booleanIndicates whether ot not the Webhook is disabled. When set to true the webhook is disabled, and notifications for events associated with it will not be sent.
falsecurl -X POST 'https://example.vii.au01.mattr.global/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
Retrieves a list of webhooks configured on the tenant.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>limit?numberRange size of returned list.
1 <= value <= 1000100cursor?stringStarting point for the list of entries.
Webhooks retrieved
application/json- response
data?array<>2 <= itemsnextCursor?stringcurl -X GET 'https://example.vii.au01.mattr.global/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
Retrieve a specific Webhook by providing its ID.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>webhookId*stringThe requested Webhook ID.
uuidWebhook retrieved
application/json- response
id?stringWebhook id
uuidevents?array<string>List of events that trigger the Webhook.
url?stringThe URL that will receive the Webhook events data payload when they are triggered.
uridisabled?booleanIndicates whether ot not the Webhook is disabled. When set to true the webhook is disabled, and notifications for events associated with it will not be sent.
falsecurl -X GET 'https://example.vii.au01.mattr.global/v1/webhooks/41458e5a-9092-40b7-9a26-d4eb43c5792f'{ "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c", "events": [ "OpenIdCredentialIssued" ], "url": "https://example.com", "disabled": false}Update a Webhook
Updates an existing Webhook by providing its ID.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>webhookId*stringWebhook ID
uuidUpdate Webhook
application/json- body
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*stringThis 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.
uridisabled?booleanIndicates 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.
Webhook updated
application/json- response
id?stringUnique identifier for the created Webhook. You will need it to verify Webhook requests.
uuidevents?array<string>List of events that trigger the Webhook, as defined in the request.
url?stringThe URL that will receive the Webhook events data payload when they are triggered, as defined in the request.
uridisabled?booleanIndicates whether ot not the Webhook is disabled. When set to true the webhook is disabled, and notifications for events associated with it will not be sent.
falsecurl -X PUT 'https://example.vii.au01.mattr.global/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
Deletes a Webhook by providing its ID.
Roles
Analytics Events
bearerAuthAuthorizationBearer <token>webhookId*stringWebhook ID
uuidWebhook deleted
curl -X DELETE 'https://example.vii.au01.mattr.global/v1/webhooks/41458e5a-9092-40b7-9a26-d4eb43c5792f'Retrieve Webhook 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.
Webhook JWKs retrieved
application/json- response
keys?array<>curl -X GET 'https://example.vii.au01.mattr.global/v1/webhooks/jwks'{ "keys": [ { "kty": "OKP", "crv": "Ed25519", "x": "11qYAYKxCrfVS_7TyWQHOg7hcvPapiMlrwIaaPcHURo", "use": "sig", "kid": "FdFYFzERwC2uCBB46pZQi4GG85LujR8obt-KWRBICVQ" } ]}How would you rate this page?
Last updated on