Hotjar Events API

The Hotjar Events API is a client-side JavaScript API that allows developers to send custom events to Hotjar when specific actions take place on a website. These events can be used to filter collected Recordings and Heatmap data, trigger session capture, and target Surveys to appear based on user behavior. Events are sent using the Hotjar tracking code and are available on all pages where the tracking snippet is installed.

API entry from apis.yml

apis.yml Raw ↑
aid: hotjar:events-api
name: Hotjar Events API
tags:
- Analytics
- Events
- Heatmaps
- Recordings
- Surveys
- Tracking
image: https://kinlane-productions2.s3.amazonaws.com/apis-json/apis-json-logo.jpg
baseURL: https://api.example.com
humanURL: https://help.hotjar.com/hc/en-us/articles/36819965075473-Events-API-Reference
properties:
- url: https://help.hotjar.com/hc/en-us/articles/36819965075473-Events-API-Reference
  type: Documentation
description: The Hotjar Events API is a client-side JavaScript API that allows developers to send custom
  events to Hotjar when specific actions take place on a website. These events can be used to filter collected
  Recordings and Heatmap data, trigger session capture, and target Surveys to appear based on user behavior.
  Events are sent using the Hotjar tracking code and are available on all pages where the tracking snippet
  is installed.