API Reference/Webhooks

Webhooks

Register HTTPS endpoints to receive real-time platform event notifications. All deliveries are signed with HMAC-SHA256.

GET/webhooksGET/webhooks/{id}GET/webhooks/event-typesPOST/webhooksPOST/webhooks/{id}/testDELETE/webhooks/{id}

The Webhook Object

FieldTypeDescription
idstringUnique webhook subscription ID (e.g. wh_001)
urlstringHTTPS endpoint that receives event POST requests
eventsstring[]List of event type patterns to subscribe to (e.g. workflow.completed, agent.*)
statusstringSubscription health: active | paused | failing | disabled
secretstringHMAC-SHA256 signing secret prefixed with whsec_ (shown only on creation)
failureCountintegerNumber of consecutive failed delivery attempts (auto-pauses at 10)
lastDeliveredAtnullabledatetimeISO 8601 UTC timestamp of the last successful delivery
createdAtdatetimeISO 8601 UTC timestamp when the subscription was created

Endpoints

Returns all webhook subscriptions for a project.

Parameters

ParameterInTypeRequiredDescription
projectIde.g. proj_rpm_001querystringrequiredProject ID

Request

curl "https://api.healthcloud.ai/v1/webhooks?projectId=proj_rpm_001" \
  -H "Authorization: Bearer hc_test_sk_demo_live_xxxxxx"

Response

Response200
{
  "data": [
    {
      "id": "wh_001",
      "url": "https://api.yourapp.com/webhooks/healthcloud",
      "events": ["workflow.completed", "diagnostic.result_ready"],
      "status": "active",
      "secret": "whsec_••••••••",
      "createdAt": "2026-01-01T00:00:00Z"
    }
  ]
}

Previous

Events

Related Resources

OrganizationsUsersProjectsAssets