light-mode-image
Learn

API Reference

Create a Webhook

POST/v1/webhooks

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

The webhook payload

events*array<string>

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

application/json

curl -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
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve all Webhooks

GET/v1/webhooks

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

Response Body

application/json

application/json

curl -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"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve a Webhook

GET/v1/webhooks/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

The requested Webhook ID.

Formatuuid

Response Body

application/json

application/json

curl -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
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Update a Webhook

PUT/v1/webhooks/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Webhook ID

Formatuuid

Request Body

application/json

Update Webhook

events*array<string>

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

application/json

application/json

curl -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
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete a Webhook

DELETE/v1/webhooks/{id}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Webhook ID

Formatuuid

Response Body

application/json

application/json

curl -X DELETE "https://example.vii.au01.mattr.global/v1/webhooks/41458e5a-9092-40b7-9a26-d4eb43c5792f"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve Webhook JWKs

GET/v1/webhooks/jwks

Response Body

application/json

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?

Guide

Previous Page

Overview

Next Page

On this page

Create a WebhookRetrieve all WebhooksRetrieve a WebhookUpdate a WebhookDelete a WebhookRetrieve Webhook JWKs