most relevant results

developer center results

Event Webhooks Integration (beta)

Heap Connect provides you with real-time streams of events in Heap. This includes labeled events created in Heap, custom events sent via our API, and events captured by other third party sources. Events will be sent via webhooks calls.

Stability Limitations
We don't recommend using Heap webhooks for mission-critical workflows as this feature is in beta. Here are some specific limitations to keep in mind:

  • Latency: Webhooks are intended to be triggered in near real-time when events happen (< 10-second latency), though during the beta, we cannot make latency guarantees. Additionally, if you use the ​addUserProperties​ API call within 15 minutes prior to a webhook is triggered, it’s possible that the user properties submitted with the webhook will reflect the user’s properties (or lack thereof) prior to the addUserProperties​ API call.
  • Uptime and deliverability: We can't make uptime or deliverability guarantees while the feature is in beta.
  • Scale: The beta product hasn't been load-tested at scale. You may experience limitations as additional webhooks are created due to resource sharing. We may choose to shut down an individual webhook or all webhooks for an account if it is causing scaling problems on our end.
  • Feature set: Any features or functionality developed in the beta phase are subject to be changed or removed completely. The generally available version of webhooks may or may not resemble the product you use during the beta.

API Limitations

  • The JSON request body only supports one level of nesting.
  • The JSON request body doesn't support complex data structures such as arrays.
  • Webhooks only support basic header authentication methods.

Webhooks

For any event in Heap, you can tell Heap to POST a JSON message to a specific URL when that event happens. Customers typically build a homegrown event capture system with an HTTP ingestion endpoint that can be used in the webhooks configuration.

To create a webhook, complete the following steps:

  1. Navigate to the webhooks console on the left sidebar in the application.
  2. Click New Webhook.
  3. Enter the endpoint URL that you want to hit when the event is triggered. Currently, only POST requests are supported.
  4. Enter the HTTP headers required.
  5. You can choose to include JSON in the HTTP body as well. The keys in the JSON object should be strings, while the values can be a constant value, a nested object, any event property, or any user property. You can design the JSON body to deliver specific metadata pertinent to the event or the user performing the event.
  6. Finally, specify the event or events that should trigger this webhook.

Use Cases

  • Real-time reporting of key KPIs.
  • Business uptime monitoring and anomaly detection on core events.
  • Connect to in-house real-time systems handling personalization and customer engagement.
  • Streaming to a data lake for real-time data access by organizational data consumers.
  • Stream product usage data to third party tools like Zendesk, Slack, and Salesforce to keep internal teams updated on customer engagement.

Supported APIs

Last updated