Skip to main content
GET
/
v0
/
webhooks
List webhooks
curl --request GET \
  --url https://test-api.shodai.network/v0/webhooks \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "wh_123",
      "principalId": "principal_123",
      "url": "https://example.com/shodai/webhooks",
      "status": "active",
      "eventTypes": [
        "agreement.transitioned",
        "agreement.notification.triggered"
      ],
      "filters": {
        "templateIds": [
          "did:template:service-retainer-v0-1"
        ],
        "ruleIds": [
          "deployment-follow-up"
        ]
      },
      "createdAt": "2026-05-26T16:00:00.000Z",
      "updatedAt": "2026-05-26T16:00:00.000Z"
    }
  ],
  "pageInfo": {
    "limit": 25,
    "nextCursor": null,
    "totalCount": 1
  },
  "meta": {
    "apiVersion": "v0",
    "requestId": "req_123"
  }
}

Authorizations

X-API-Key
string
header
default:YOUR_API_KEY
required

Canonical API-key credential. Send X-API-Key: cns_pk_..., or Authorization: Bearer cns_pk_... only as an API-key compatibility alias. OAuth and JWT bearer tokens are not supported.

Response

Webhook subscriptions.

data
object[]
required
pageInfo
object
required
meta
object
required