Update Webhook

PATCH {{BASE_HABITAT_URL}}/api/webhooks/:id

Required scope: webhooks:write

Partially updates a webhook. Only supplied fields change.

Path parameter	Notes
id	Webhook UUID returned by Create Webhook or List Webhooks.

All body fields are optional and use the same formats as Create Webhook: url, event_filter, active, description, and http_options.headers.

• event_filter replaces the complete filter list. Include every lifecycle status and event you want to retain.
• Add "ready_now" to opt into the Ready Now event.
• Send "event_filter": null to receive every event; an empty array receives none.
• http_options replaces all stored headers. Include every header you want to retain and never copy masked values from List Webhooks.
• Send "active": false to pause delivery.

The response echoes changed fields. Call List Webhooks to verify the full stored configuration.

Request body

{
    "active": true,
    "event_filter": [
        "ready_now",
        "completed",
        "cancelled"
    ]
}

Examples

cURL

curl --request PATCH '${BASE_HABITAT_URL}/api/webhooks/:id' \
  --data '{
    "active": true,
    "event_filter": [
        "ready_now",
        "completed",
        "cancelled"
    ]
}'

Node.js

const response = await fetch("${BASE_HABITAT_URL}/api/webhooks/:id", {
  "method": "PATCH",
  "headers": {},
  "body": "{\n    \"active\": true,\n    \"event_filter\": [\n        \"ready_now\",\n        \"completed\",\n        \"cancelled\"\n    ]\n}"
})
const data = await response.json()

Python

import requests

response = requests.request(
    "PATCH",
    "${BASE_HABITAT_URL}/api/webhooks/:id",
    headers={},
    data="{\n    \"active\": true,\n    \"event_filter\": [\n        \"ready_now\",\n        \"completed\",\n        \"cancelled\"\n    ]\n}",
)
response.raise_for_status()

Saved responses

200 200 OK

{
    "type": "success",
    "webhook": {
        "active": true,
        "event_filter": ["completed", "cancelled"]
    }
}