The Hotjar connector lets your AI agent act in each user's Hotjar account. Each user signs in to Hotjar once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 5 tools.
- Tools
- 5
- What they doRead · write · destructive
- 3 · 1 · 13 read1 write1 destructive
- Users sign in with
- Service account
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Hotjar connection
In AgentKit > Connections, create a Hotjar connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toolhotjar_survey_getGet one Hotjar survey by ID, always with its questions.Read-onlyGet Survey
Get one Hotjar survey by ID, always with its questions. Returns the survey's id, name, type, enabled flag, timestamps, sentiment analysis flag and questions (id, type, text, required flag, choices and labels). Use this when you have a survey ID. Use hotjar_surveys_list to find one and hotjar_survey_responses_list for its answers.
Inputs
site_idstringrequired- The Hotjar site ID. Find it in Hotjar under Sites & Organizations, next to the site. Example: 1234567.
survey_idstringrequired- The survey ID, as returned in the id field by hotjar_surveys_list. Example: survey_f5937a53-674a-43d1-b4b7-ada420568ebf.
hotjar_survey_responses_listList the responses to a Hotjar survey, newest first, one page at a time.Read-onlyList Survey Responses
List the responses to a Hotjar survey, newest first, one page at a time. Hotjar does not support filtering responses. Returns each response's id, answers (question_id, answer, comment, tags and sentiment), completion flag, created_time, country, device, browser, OS, origin URL, recording URL, Hotjar user ID and user attributes, plus next_cursor. Use this to read survey answers. Match question_id to the questions from hotjar_survey_get.
Inputs
site_idstringrequired- The Hotjar site ID. Find it in Hotjar under Sites & Organizations, next to the site. Example: 1234567.
survey_idstringrequired- The survey ID, as returned in the id field by hotjar_surveys_list. Example: survey_f5937a53-674a-43d1-b4b7-ada420568ebf.
cursorstring- Cursor for the next page: pass the next_cursor value from the previous hotjar_survey_responses_list response. Leave empty for the first page.
limitinteger- Number of responses to return per page, up to 100. Leave empty for Hotjar's default page size.
hotjar_surveys_listList the surveys on a Hotjar site, one page at a time.Read-onlyList Surveys
List the surveys on a Hotjar site, one page at a time. Returns each survey's id, name, type (link, full_screen or popover), enabled flag, timestamps and responses URL, plus questions when with_questions is true, and next_cursor. Use this to find a survey ID. Use hotjar_survey_get for one survey's questions and hotjar_survey_responses_list for its answers.
Inputs
site_idstringrequired- The Hotjar site ID. Find it in Hotjar under Sites & Organizations, next to the site. Example: 1234567.
cursorstring- Cursor for the next page: pass the next_cursor value from the previous hotjar_surveys_list response. Leave empty for the first page.
limitinteger- Number of surveys to return per page, up to 100. Leave empty for Hotjar's default page size.
with_questionsboolean- Set to true to include each survey's questions in the response. Defaults to false.
hotjar_user_lookup_requestStart a data subject lookup for one person across a Hotjar organization, without deleting anything.WriteRequest User Data Lookup
Start a data subject lookup for one person across a Hotjar organization, without deleting anything. Returns 202 Accepted with no body; Hotjar emails a link to the data report to the data subject's email and to the organization's default User Lookup recipient. Use this for a data access request. Use hotjar_user_data_delete to erase the person's data instead.
Inputs
organization_idstringrequired- The Hotjar organization ID. Find it in Hotjar under Sites & Organizations, next to the organization. Example: 987654.
data_subject_emailstring- Email address of the person whose data to look up. Send this, data_subject_site_id_to_user_id_map, or both. Example: jane@example.com.
data_subject_site_id_to_user_id_mapobject- Map of Hotjar site ID to the user ID your site sent through the Hotjar Identify (User Attributes) API, for each site where the person may appear. Send this, data_subject_email, or both. Example: {"1234567": "user_42"}.
hotjar_user_data_deleteFind and permanently delete all Hotjar data for one person across an organization.DestructiveDelete User Data
Find and permanently delete all Hotjar data for one person across an organization. This cannot be undone and sends no email or report. Returns 202 Accepted with no body. Use this for a data erasure request. Use hotjar_user_lookup_request to get a report without deleting.
- Idempotent
Inputs
organization_idstringrequired- The Hotjar organization ID. Find it in Hotjar under Sites & Organizations, next to the organization. Example: 987654.
data_subject_emailstring- Email address of the person whose data to look up. Send this, data_subject_site_id_to_user_id_map, or both. Example: jane@example.com.
data_subject_site_id_to_user_id_mapobject- Map of Hotjar site ID to the user ID your site sent through the Hotjar Identify (User Attributes) API, for each site where the person may appear. Send this, data_subject_email, or both. Example: {"1234567": "user_42"}.
No tools match.