Halliday Webhooks API
Register HTTPS endpoints to receive signed notifications when a workflow reaches a terminalstate, instead of polling for status. You subscribe to one or more event types per webhook.| Event type | Fires when a workflow's status becomes || --- | --- || `WORKFLOW_COMPLETED` | `COMPLETE` || `WORKFLOW_FAILED` | `FAILED` |All management endpoints live under `/orgs/webhooks` and authenticate with a secret API key(passed as a bearer token) that has webhook access. Publishable keys cannot manage webhooks.**Integration checklist**- Receiver is a public HTTPS endpoint (no private IPs).- Save the `signing_secret` when you create the webhook — it is shown only once.- Verify `X-Halliday-Signature` against the raw body, accepting any of its comma-separated signatures.- Respond `2xx` quickly and do the real work afterward.- Skip deliveries whose `id` you have already handled.
Halliday Webhooks API is one of 4 APIs that Halliday publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.
This API exposes 5 operations across 2 paths, and defines 26 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://v2.prod.halliday.xyz.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Halliday Webhooks API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (API_KEY) (ApiKeyAuth).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Register HTTPS endpoints to receive signed notifications when a workflow reaches a terminal state, instead of polling for status. You subscribe to one or more event types per webh…
Schemas 26
The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are AmountIssue (8 properties), AmountDownstreamIssue (8 properties), WebhookSummary (6 properties), RegisterWebhookRequest (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Halliday 3
Other APIs Halliday publishes across the network.