NDNCI Docs
API v1API reference

List workspace webhooks

List registered webhook destinations in the selected workspace without returning their signing secrets.

GET/v1/webhooks

Authorization

bearerKey
AuthorizationBearer <token>

A scoped automation key authorized for the REST API.

In: header

Header Parameters

X-Ndnci-Workspace*string

Select a workspace explicitly included in this access grant.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/webhooks" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <NDNCI_API_KEY>"
{  "success": true,  "code": "PUBLIC_WEBHOOKS_LIST",  "message": "Successful response",  "data": {    "items": [      {        "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:read · Usage points: 2

Credits are charged separately for work that consumes paid services.

Read workspace events GET

Read a bounded event page for the selected workspace. Persist the returned cursor only after processing each event successfully; events never grant access outside the approved workspace.

Create a signed webhook POST

Register an HTTPS endpoint on an exact hostname verified in the selected workspace. The signing secret is shown once in this response.