DocsInstallation and setup
Getting started

Installation and setup

There is no SDK to configure and no event schema to design. One script tag, and Jellyhook starts recording sessions, scroll depth, and form activity on its own.

01

Create a site

From your dashboard, register the domain you want to track. Enter it without https:// or www., for example yourdomain.com. Jellyhook generates a unique API key for it. This key is what authenticates every event the tracker sends, so nothing else can post fake data under your site.

Install the script on this exact domain. Jellyhook only records events that come from this domain (and its subdomains), and it is what proves the site is yours: the first site to receive real data from a domain is verified and owns it. It is also what a teammate's work email gets matched against to join the site automatically.

Adding a domain starts a claim that lasts 3 days. If the script has not reported from your site by then, the setup expires and records nothing until you renew it with one click, or start again. Two people can set up the same domain at once; whoever installs the script on the real site first wins.

Everything recorded goes into this site's real analytics. Do not install the script on test pages, a staging copy or a local development server unless you want those visits counted with your real ones; they would be mixed in and cannot be separated afterwards. Data from any host that is not your domain is turned away by default.

One account can own or belong to more than one site. Switch between them from the site name at the top of the sidebar, or add another from the same menu.

02

Install the tracker

Paste this inside the <head> of your site. Your setup page has the exact snippet with your real API key already filled in.

<script
  defer
  src="https://jellyhook.com/tracker.js"
  data-key="YOUR_SITE_API_KEY"
></script>

defer lets the browser draw your page first and run the tracker right after, so the script never holds your page up. A snippet you copied earlier without it keeps working.

With nothing else configured, every form on your site that has an email field counts as a lead. Login, search and password forms never do, so a sign-up form with a password is not a lead. A simple site with one contact form needs nothing more.

Google Tag Manager: in Tags, New, Custom HTML, paste the snippet from your setup page's Tag Manager tab (the key is in the address, because Tag Manager drops data- attributes). Trigger it on All Pages, then Submit and Publish. No site code is touched.

Cookie banner: if your site has one, the tracker follows it with no extra setup. See Privacy and consent.

03

Choose which forms are leads

If the site has forms that are not leads (a newsletter signup, a job application), switch them off. Each form appears in Settings, Lead forms after its first submission, with a Lead and a Not a lead switch. No code is needed. A form that is not a lead is only counted: its name, email and answers are never kept. Changes apply within about a minute, and leads already recorded stay.

If you prefer to decide in code, the optional attribute data-conversion does it. It always wins over the switch. Two more optional attributes choose which fields of a form are measured and which buttons are counted. Settings, Attribute check shows whether each one is found and working. See Tracking attributes.

04

If it looks stuck on "Pending Verification"

Right after creating a site, the dashboard shows a "Listening for connection..." screen and checks every few seconds. The instant one real event arrives with the right API key from your own domain, the site is marked verified and the page moves on by itself. There is no separate approval step. An event from any other website does not verify the site, even with the right key.

If it stays on this screen, check, in order:

  • The script is deployed and live, not just saved locally or sitting in a preview build.
  • The page you are viewing is the domain you registered. If the screen says "We received data from another-site.com", the script is on a different website than the one you registered: move it, or allow that host if it is a test copy.
  • The setup has not expired. After 3 days without data it stops recording until renewed; the screen shows a Renew button.
  • The data-key in the snippet matches exactly, no extra spaces or a key copied from a different site.
  • Nothing on the page (an ad blocker, a strict content security policy) is blocking the script from loading at all.

Registered the wrong domain entirely? Cancel and start over from the same screen, no site gets left behind half-configured.

05

Once it is verified

The tracker identifies each visitor and session, records every page view with scroll depth and time on page, and picks up form activity on its own from here. No further setup is required.

Settings → Tracker shows the last time data arrived, any other website that sent data and was turned away, and whether your attributes are working. If you ever regenerate the API key, the old one keeps working for 72 hours so there is no gap in tracking.

What gets collected

Exactly this, and nothing more. See Privacy for the full breakdown of storage and retention.

Session data

Session start and end, referrer, timezone, device type and approximate country. The IP address is kept only as a one-way hash, never in the clear.

First touch

For a new visitor's first visit only: the referrer, UTM campaign and landing page that brought them. Kept on the visitor, never overwritten.

Page views

Page path, time on page, scroll depth, max scroll depth, page height, viewport height and width.

Clicks

Only on elements you mark with data-track-click. Nothing else is clicked-tracked.

Form submissions

Name, email, phone, and any other fields the form collects, tied to the page and session it came from.

Form engagement

When a form was viewed, when it was started, and how long was spent on each field, even if it was never submitted.

Page structure

Heading text and position on each page, used to mark headings on the visit chart.

Ingestion endpoints

Reference only. The tracker script calls these for you. Every request is authenticated with your site's API key.

/api/trackCore ingestion endpoint. Receives page view and session events from the tracker script.
/api/track-formReceives form submissions and stores them as leads, deduplicated within a short window.
/api/track-form-engagementReceives form view, start, field timing, submit, and abandon events.
/api/track-structureReceives page heading and layout metadata, used on the visit chart.
/api/site-configReturns per-site tracker configuration, for example whether form capture is restricted to specific forms.