Webhooks API Updates

Update: Create a webhook

Request payload should be sent directly without nesting under data. This is a documentation-only correction — no API behaviour has changed.

API Reference: Create a webhook

Request body (Before):

{
  "data": {
    "status": "enabled",
    "api_version": "v2",
    "name": "Contract updates",
    "description": "Get contract events",
    "url": "https://mywebhook.com/create-contract",
    "events": [
      "contract.created",
      "contract.amended"
    ]
  }
}

Request body (Current):

{
  "status": "enabled",
  "api_version": "v2",
  "name": "Contract updates",
  "description": "Get contract events",
  "url": "https://mywebhook.com/create-contract",
  "events": [
    "contract.created",
    "contract.amended"
  ]
}

Update: Edit a webhook

Request payload should be sent directly without nesting under data. This is a documentation-only correction — no API behaviour has changed.

API Reference: Edit a webhook

Request body (Before):

{
  "data": {
    "status": "enabled",
    "api_version": "v2",
    "name": "updated name",
    "description": "updated description",
    "url": "https://mywebhook.com/listening",
    "events": [
      "contract.created"
    ]
  }
}

Request body (Current):

{
  "status": "enabled",
  "api_version": "v2",
  "name": "updated name",
  "description": "updated description",
  "url": "https://mywebhook.com/listening",
  "events": [
    "contract.created"
  ]
}