light-mode-image
Learn
API ReferenceWebhooks

Retrieve Webhook

Roles

adminissuermanaged-issuer

Analytics Events

WEBHOOK_RETRIEVE_STARTWEBHOOK_RETRIEVE_SUCCESSWEBHOOK_RETRIEVE_FAIL
GET/v1/webhooks/{id}

Retrieve a specific Webhook by providing its ID.

Analytic events

  • WEBHOOK_RETRIEVE_START
  • WEBHOOK_RETRIEVE_SUCCESS
  • WEBHOOK_RETRIEVE_FAIL

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"
    }
  ]
}

How would you rate this page?

Retrieve all Webhooks GET

Retrieves a list of webhooks configured on the tenant. ### **Analytic events** * WEBHOOK_RETRIEVE_LIST_START * WEBHOOK_RETRIEVE_LIST_SUCCESS * WEBHOOK_RETRIEVE_LIST_FAIL

Update Webhook PUT

Updates an existing Webhook by providing its ID. ### **Analytic events** * WEBHOOK_UPDATE_START * WEBHOOK_UPDATE_SUCCESS * WEBHOOK_UPDATE_FAIL