Skip to main content
PUT
/
webhooks
/
{webhookId}
Update webhook
curl --request PUT \
  --url https://api.natural.co/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "data": {
    "attributes": {
      "description": "Production webhook — wallet, party, and delegation events",
      "status": "DISABLED",
      "enabledEvents": [
        "wallet.created",
        "party.updated"
      ]
    }
  }
}
'
{
  "data": {
    "type": "webhook",
    "id": "whk_0192abc1def2789034567890abcdef12",
    "attributes": {
      "url": "https://example.com/webhooks/natural",
      "description": "Production webhook — wallet, party, and delegation events",
      "status": "DISABLED",
      "enabledEvents": [
        "wallet.created",
        "party.updated"
      ],
      "tags": {
        "env": "prod",
        "team": "payments"
      },
      "createdAt": "2026-03-16T12:00:00Z",
      "updatedAt": "2026-03-17T08:15:00Z"
    },
    "relationships": {
      "party": {
        "data": {
          "type": "party",
          "id": "pty_7c9e6679e29b41d4a716446655440001"
        }
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.natural.co/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

Unique key for idempotent request handling. If a request with the same key was already processed, the original response is returned.

X-Agent-ID
string | null

Agent ID (agt_xxx) identifying which agent is making the request.

X-Instance-ID
string | null

Required when X-Agent-ID is present. Session or conversation ID for agent observability.

Maximum string length: 1024

Path Parameters

webhookId
string
required

Webhook ID (whk_xxx)

Body

application/json
data
WebhookUpdateData · object
required

Response

Successful Response

data
WebhookResource · object
required