Skip to main content
HelloBooks.ai home
Endpoint Reference

DELETE /public/v1/orgs/:orgId/entities/:entityId/webhooks/:id

Soft-delete a webhook subscription. Subsequent listings exclude it; the row is preserved for audit.

Reference

Method: DELETE Path: /public/v1/orgs/:orgId/entities/:entityId/webhooks/:id Auth: Bearer marketplace token Tenant guard: enforced Required scope: none beyond a valid install

Behavior

Sets IsActive: false on the subscription. The row remains in the database for auditing — it is not hard-deleted. Subsequent calls to LIST will not include it.

If the subscription doesn't exist OR belongs to a different install OR is already inactive, the response is still 200 — but modified: 0. Treat modified: 0 as a soft-not-found.

Response

{ "ok": true, "modified": 1 }
FieldTypeNotes
okbooleanAlways true for a 200 response
modifiednumber1 if the subscription was found and deactivated, 0 otherwise

Curl example

curl -s -X DELETE -H "Authorization: Bearer $HB_TOKEN" \
  https://api.hellobooks.com/public/v1/orgs/$HB_ORG/entities/$HB_ENT/webhooks/$HB_SUB | jq

Related

POST /public/v1/orgs/:orgId/entities/:entityId/webhooks

Subscribe to one or more event topics. Returns the subscription row and a one-time signing_secret.

GET /public/v1/orgs/:orgId/entities/:entityId/webhooks

List active webhook subscriptions for the install, including delivery health metrics.

Back to Endpoint Reference
All sectionsTry HelloBooks free
    API Reference: Delete Webhook Subscription