Heap Webhooks API
Partner-registered webhook endpoints invoked by Heap. The onlydocumented action type is `segment.users.sync`, which deliversdelta adds/removes for a Heap behavioral segment.Signature verification: 1. Parse the `Heap-Hash` header (comma-separated key:value pairs). 2. Confirm the `ts` value is within the partner's tolerance window. 3. Concatenate `${ts}${requestbody}`. 4. Compute HMAC-SHA256 using the `webhook_secret_key` assigned at webhook creation. 5. Constant-time compare against the `hmac` value from the header.Return `200 OK` on success; `429` or other non-2xx responses triggerretries by Heap.
Heap Webhooks API is one of 10 APIs that Heap 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, and an API reference.
This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://heapanalytics.com.
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.
Partner-registered webhook endpoints invoked by Heap. The only documented action type is segment.users.sync, which delivers delta adds/removes for a Heap behavioral segment. Signa…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are SegmentDeltaSync (4 properties), WebhookSyncRequest (4 properties), SyncInfo (3 properties), SegmentInfo (2 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 Heap 9
Other APIs Heap publishes across the network.