How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Heap

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

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 Webhook. 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.2.0, at version 0.0.1.

Requests are made against a single base URL, https://partner.example.com.

1 operations 1 paths 5 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Server
https://partner.example.com
Contact
Heap Developers
Resource Areas
1

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.

Webhooks 1

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…

POST
/{partner_webhook_sync_url}
segment.users.sync webhook receiver
segmentUsersSync 2 params body → 200403429default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are WebhookSyncRequest (4 properties), SegmentDeltaSync (4 properties), SyncInfo (3 properties), SegmentInfo (2 properties). Each schema is shown below with its type and property counts.

SegmentDeltaSync
object
4 properties
SegmentInfo
object
2 properties
SyncInfo
object
3 properties
CustomerConfig
object
Optional customer-supplied configuration captured during integration setup.
1 property
WebhookSyncRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

heap-webhooks-api-openapi.yml Raw ↑

Other APIs Heap publishes across the network.

Heap Server-Side API
AE Profile APIs.io
Heap Track API
AE Profile APIs.io
Heap Identify API
AE Profile APIs.io
Heap Add User Properties API
AE Profile APIs.io
Heap Add Account Properties API
AE Profile APIs.io
Heap Add Account Properties API
AE Profile APIs.io
Heap Add User Properties API
AE Profile APIs.io
Heap Identify API
AE Profile APIs.io
Heap Track API
AE Profile APIs.io
#Webhook
← Back to H APIs
API Details
ID
heap:heap-webhooks-api
Server
https://partner.example.com
Docs
https://developers.heap.io/reference/server-side-apis-overview
Provider
Heap
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=heap-webhooks-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/heap-webhooks-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Heap Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.