Skip to main content
GET
/
v0
/
webhooks
/
{id}
Get webhook
curl --request GET \
  --url https://test-api.shodai.network/v0/webhooks/{id} \
  --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"
  },
  "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.

Path Parameters

​
id
string
required

Webhook subscription ID.

Response

Webhook subscription.

​
data
object
required
Example:
{
  "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"
}
​
meta
object
required