List webhooks
curl --request GET \
--url https://test-api.shodai.network/v0/webhooks \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://test-api.shodai.network/v0/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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,
"nextCursor": null,
"totalCount": 1
},
"meta": {
"apiVersion": "v0",
"requestId": "req_123"
}
}
Webhooks
List webhooks
Lists webhook subscriptions for the authenticated Shodai account. Signing secrets are not returned after creation.
GET
/
v0
/
webhooks
List webhooks
curl --request GET \
--url https://test-api.shodai.network/v0/webhooks \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://test-api.shodai.network/v0/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"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,
"nextCursor": null,
"totalCount": 1
},
"meta": {
"apiVersion": "v0",
"requestId": "req_123"
}
}
Authorizations
ApiKeyAuthOAuthBearerAuth
Was this page helpful?
⌘I