NDNCI Docs
API v1API reference

Update a webhook

Replace the webhook destination, subscribed events and enabled state after checking the verified hostname and current workspace authorization again.

POST/v1/webhooks/{webhookId}/update

Authorization

bearerKey
AuthorizationBearer <token>

A scoped automation key authorized for the REST API.

In: header

Path Parameters

webhookId*string
Formatuuid

Header Parameters

X-Ndnci-Workspace*string

Select a workspace explicitly included in this access grant.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/update" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <NDNCI_API_KEY>" \  -H "Content-Type: application/json" \  -d '{    "url": "https://hooks.example.org/ndnci",    "eventTypes": [      "job.completed",      "job.failed"    ],    "enabled": true  }'
{  "success": true,  "code": "PUBLIC_WEBHOOKS_UPDATE",  "message": "Successful response",  "data": {    "id": "123e4567-e89b-42d3-a456-426614174007",    "workspaceId": "123e4567-e89b-42d3-a456-426614174001",    "url": "https://hooks.example.org/ndnci",    "eventTypes": [      "job.completed",      "job.failed"    ],    "enabled": true,    "createdAt": "2026-10-01T12:00:00Z",    "updatedAt": "2026-10-01T12:00:00Z"  }}

Required scope: webhooks:write · Usage points: 5

Credits are charged separately for work that consumes paid services.