PATCH Update Webhook

Update the core properties of a webhook. This endpoint accepts both PATCH and PUT. It does not modify subscriptions. Use the Subscriptions endpoints to add, update, or remove subscriptions.

/webhooks/v1/<id>/webhooks/v1/<id>

Path parameters

Name	Type	Description
id Required	integer	Unique webhook identifier.

Request parameters

Name	Type	Description
url Optional	string	The HTTPS URL to deliver payloads to. Must be publicly reachable.
name Optional	string	Short human-readable label (e.g. "Iceland Campaign"). Shown in list views.
note Optional	string	Free-text description returned with every delivery. Useful for providing context to LLMs or downstream automation.
active Optional	boolean	Whether the webhook is enabled.

Examples

curl -X PATCH -u "$WB_CLIENT_ID:$WB_API_KEY" \curl -X PATCH -u "$WB_CLIENT_ID:$WB_API_KEY" \

-H "Content-Type: application/json" \ -H "Content-Type: application/json" \

-d '{"name":"Updated Name","active":false}' \ -d '{"name":"Updated Name","active":false}' \

"https://api.windbornesystems.com/webhooks/v1/42" "https://api.windbornesystems.com/webhooks/v1/42"

content-type: application/json

1 {{

2 "id": 42, "id": 42,

3 "name": "Updated Name", "name": "Updated Name",

4 "note": null, "note": null,

5 "url": "https://example.com/webhook", "url": "https://example.com/webhook",

6 "active": false, "active": false,

7 "subscriptions": [ "subscriptions": [

8 { {

9 "id": 81, "id": 81,

10 "subscription_type": "initialization_time.available", "subscription_type": "initialization_time.available",

11 "note": null, "note": null,

12 "filters": { "filters": {

13 "model": "wm-6" "model": "wm-6"

14 } }

15 } }

16 ], ],

17 "created_at": "2025-03-09T12:00:00Z", "created_at": "2025-03-09T12:00:00Z",

18 "updated_at": "2025-03-09T12:30:00Z" "updated_at": "2025-03-09T12:30:00Z"

19 }}