Skip to main content
Endpoint Reference

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

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

Reference

Method: GET Path: /public/v1/orgs/:orgId/entities/:entityId/webhooks Auth: Bearer marketplace token Tenant guard: enforced Required scope: none beyond a valid install Filter: returns only IsActive: true rows. Soft-deleted subscriptions are excluded.

Response

{
  "subscriptions": [
    {
      "_id": "65f1aa...",
      "Topics": ["invoice.paid", "bill.created"],
      "TargetUrl": "https://your-app.example.com/hellobooks/webhook",
      "IsActive": true,
      "LastDeliveryAt": "2026-05-04T10:18:11.420Z",
      "LastDeliveryStatus": 200,
      "ConsecutiveFailures": 0,
      "createdAt": "2026-05-04T10:14:32.123Z"
    }
  ]
}
FieldTypeNotes
_idstringSubscription ID — use as :id in DELETE
Topicsstring[]Subscribed topics (already lowercased)
TargetUrlstringWhere deliveries are sent
IsActivebooleanAlways true in this response
LastDeliveryAtstring \nullISO timestamp of last attempt
LastDeliveryStatusnumber \nullHTTP status of last attempt
ConsecutiveFailuresnumberResets to 0 on any successful (2xx) delivery
createdAtstringISO timestamp

Curl example

curl -s -H "Authorization: Bearer $HB_TOKEN" \
  https://api.hellobooks.com/public/v1/orgs/$HB_ORG/entities/$HB_ENT/webhooks | jq
    API Reference: List Webhook Subscriptions