Webhooks

List webhooks

Lists webhook subscriptions for the authenticated Shodai account. Signing secrets are not returned after creation.

get/v0/webhooks

Request

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

Response

Webhook subscriptions.

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"
    }
  ],
  "pageInfo": {
    "limit": 25
  },
  "meta": {
    "apiVersion": "v0"
  }
}

Changes

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