Webhooks

Get webhook

Returns one webhook subscription for the authenticated Shodai account. The signing secret is not returned after creation.

get/v0/webhooks/{id}

Request

  • Base URL: https://test-api.shodai.network
  • URL: https://test-api.shodai.network/v0/webhooks/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

idstring required

Webhook subscription ID.

Response

Webhook subscription.

Example response

{
  "data": {
    "id": "wh_123",
    "principalId": "account_123",
    "createdByApiKeyId": null,
    "url": "https://example.com/shodai/webhooks",
    "status": "active",
    "eventTypes": [
      "agreement.transitioned",
      "agreement.notification.triggered"
    ],
    "filters": {
      "templateIds": [
        "did:template:service-retainer-v0-1"
      ]
    },
    "createdAt": "2026-05-26T16:00:00.000Z",
    "updatedAt": "2026-05-26T16:00:00.000Z"
  },
  "meta": {
    "apiVersion": "v0"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.