Sign upLogin
DocumentationAPI Reference
API referenceWebhooks

Replace an endpoint's event subscriptions

Requires a current workspace administrator personal access token. This is a full replacement, not an additive patch.

PUT
/api/v1/workspaces/{workspaceId}/webhook-endpoints/{endpointId}/subscriptions

Requires a current workspace administrator personal access token. This is a full replacement, not an additive patch.

Authorization

machineBearer
AuthorizationBearer <token>

Personal access tokens and supported service-account keys are accepted only in the Authorization header and never in URLs. Each operation documents which principal types it authorizes.

In: header

Path Parameters

workspaceId*string

Workspace UUID. It must match the workspace bound to the credential.

Formatuuid
endpointId*string
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

application/json

application/json

application/json

curl -X PUT "https://example.com/api/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhook-endpoints/497f6eca-6276-4993-bfeb-53cbbbba6f08/subscriptions" \  -H "Content-Type: application/json" \  -d '{    "subscriptions": [      "story.created"    ]  }'
Empty

Get an outbound webhook endpoint GET

Requires a current workspace administrator personal access token.

Rotate an endpoint's signing secret POST

Requires a current workspace administrator personal access token. The new secret is shown once. The previous secret remains valid for the documented overlap period.