Learn

Webhooks

Specifies paths and operations for managing Webhooks.

Create Webhook

Creates a new webhook for this tenant.

Analytic events

  • WEBHOOK_CREATE_START
  • WEBHOOK_CREATE_SUCCESS
  • WEBHOOK_CREATE_FAIL
Roles: ["Admin","Issuer"]
SecuritybearerAuth
Request
Request Body schema: application/json
required

The webhook payload

events
required
Array of strings

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

  • OpenIdCredentialIssued: Triggered upon completion of an OpenID4VCI issuance flow and includes credential data.
  • OpenIdCredentialIssuedSummary: Triggered upon completion of an OpenID4VCI issuance flow but does not include credential data.
  • OidcIssuerCredentialIssued: Triggered upon completion of an OICD Bridge issuance flow.
Items Enum: "OidcIssuerCredentialIssued" "OpenIdCredentialIssued" "OpenIdCredentialIssuedSummary"
url
required
string <uri>

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.
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.

Responses
201

Webhook created

400

Bad Request. The request was malformed or missing required parameters.

post/core/v1/webhooks
Request samples
application/json
{}
Response samples
application/json
{
  • "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",
  • "events": [
    ],
  • "url": "https://example.com",
  • "disabled": false
}

Retrieve all Webhooks

Retrieves a list of webhooks configured on the tenant.

Analytic events

  • WEBHOOK_RETRIEVE_LIST_START
  • WEBHOOK_RETRIEVE_LIST_SUCCESS
  • WEBHOOK_RETRIEVE_LIST_FAIL
Roles: ["Admin","Issuer"]
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]
Default: 100

Range size of returned list.

Example: limit=2
cursor
string

Starting point for the list of entries.

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Webhooks retrieved

400

Bad Request. The request was malformed or missing required parameters.

get/core/v1/webhooks
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjItMDgtMjJUMDElM0E1OSUzQTE5LjYyMFomaWQ9MGMwOTk2MTEtMTljNC00ZjI5LTg3MjQtNmI5ZTViYTFlZjdj"
}
Retrieve Webhook
Retrieve a specific Webhook by providing its ID.


Analytic events


    

  • WEBHOOK_RETRIEVE_START
    • 

  • WEBHOOK_RETRIEVE_SUCCESS
    • 

  • WEBHOOK_RETRIEVE_FAIL
    • 



Roles:  ["Admin","Issuer"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
The requested Webhook ID.


 
 Example:  41458e5a-9092-40b7-9a26-d4eb43c5792f
Responses 
200
Webhook retrieved


400
Bad Request. The request was malformed or missing required parameters.


get/core/v1/webhooks/{id}
Request samples 
Response samples 
application/json
{
  • "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",
  • "events": [
    ],
  • "url": "https://example.com",
  • "disabled": false
}
Update Webhook
Updates an existing Webhook by providing its ID.


Analytic events


    

  • WEBHOOK_UPDATE_START
    • 

  • WEBHOOK_UPDATE_SUCCESS
    • 

  • WEBHOOK_UPDATE_FAIL
    • 



Roles:  ["Admin","Issuer"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Webhook ID


 
 Example:  41458e5a-9092-40b7-9a26-d4eb43c5792f
Request Body schema: application/json
required
Update Webhook


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


    

  • OpenIdCredentialIssued: Triggered upon completion of an OpenID4VCI issuance flow and includes credential data.
    • 

  • OpenIdCredentialIssuedSummary: Triggered upon completion of an OpenID4VCI issuance flow but does not include credential data.
    • 

  • OidcIssuerCredentialIssued: Triggered upon completion of an OICD Bridge issuance flow.
    • 



Items Enum: "OidcIssuerCredentialIssued" "OpenIdCredentialIssued" "OpenIdCredentialIssuedSummary"  
url
required
string <uri> 
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.
    • 



 
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.


 
Responses 
200
Webhook updated


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


put/core/v1/webhooks/{id}
Request samples 
application/json
{}
Response samples 
application/json
{
  • "id": "0c099611-19c4-4f29-8724-6b9e5ba1ef7c",
  • "events": [
    ],
  • "url": "https://example.com",
  • "disabled": false
}
Delete Webhook
Deletes a Webhook by providing its ID.


Analytic events


    

  • WEBHOOK_DELETE_START
    • 

  • WEBHOOK_DELETE_SUCCESS
    • 

  • WEBHOOK_DELETE_FAIL
    • 



Roles:  ["Admin","Issuer"]
SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
Webhook ID


 
 Example:  41458e5a-9092-40b7-9a26-d4eb43c5792f
Responses 
204
Webhook deleted


400
Bad Request. The request was malformed or missing required parameters.


404
Not Found. The specified resource was not found.


delete/core/v1/webhooks/{id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "type": "string",
  • "message": "string",
  • "details": [
    ]
}
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 does not require authentication and is publicly available by design.


Responses 
200
Webhook JWKs retrieved


get/core/v1/webhooks/jwks
Request samples 
Response samples 
application/json
{
  • "keys": [
    ]
}
➔ Next to Ecosystems