Skip to main content
PATCH
/
v0
/
webhooks
/
{id}
Update webhook
curl --request PATCH \
  --url https://test-api.shodai.network/v0/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "active",
  "filters": {
    "inputIds": [
      "submitInitialPaymentProof"
    ]
  }
}
'
{
  "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.

Body

application/json
​
url
string<uri>

Replacement HTTPS endpoint URL.

​
status
enum<string>

Enable or disable delivery.

Available options:
active,
disabled
​
eventTypes
enum<string>[]

Replacement subscribable event types. On update, omitted eventTypes leaves the current value unchanged; null or an empty array resets to agreement.transitioned.

Available options:
agreement.transitioned,
agreement.notification.triggered
​
filters
object

Optional filters applied before delivery. agreementIds and templateIds apply to both agreement.transitioned and agreement.notification.triggered. inputIds, fromStates, and toStates apply to agreement.transitioned and to notification events with transition data. ruleIds apply to agreement.notification.triggered events.

Response

Updated 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