What fields can i send?

Only the user ID is required, but always send the email so Atlis can email them. Optional: name, plan (e.g. free, trial, pro, annual), trialExpiresAt (e.g. 2026-12-01) and isActivated (true once they reach your key milestone). Any other fields are saved as properties.

What does activated mean?

Send isActivated: true in identify once a user reaches your key milestone. That sends the Onboarding completed email (if on) and stops the Not activated email. Don't send false on every page load; it overwrites true. First payments via Stripe/Paddle and a CRM status mapped to Activated also mark users activated.

Where do i find the user id?

Use your auth tool's permanent user ID: Firebase user.uid, Supabase user.id, Clerk user.id, Auth0 user.sub, NextAuth session.user.id (add it in the session callback). Email is user.email in most tools (Clerk: user.primaryEmailAddress.emailAddress).

Identify your users

Which user details to send, what each one does, and where to find them in popular auth tools.

Browser

window.Atlis.identify(user.id, user.email, {
  name: user.name,
  plan: "pro",
  trialExpiresAt: "2026-12-01",
  isActivated: true,
  company: "Acme"          // any extra fields are saved as properties
});

Fields

Field	Required	What it does
id	Yes	Your user's permanent unique ID (for example your database ID). Must not contain `/`. Using the same ID again updates the same user, never a duplicate.
email	For emails	Where Atlis sends workflow emails. Send it on every identify call.
name	No	Used in `{{displayName}}` in emails. `displayName` works too.
plan	No	Plan name such as `free`, `trial`, `pro` or `annual`. Feeds the Plan filter and the health score. With `AtlisConfig`, it defaults to `free` if left out.
trialExpiresAt	No	Trial end date, for example `2026-12-01`. Powers the Trial expiring in 3 days workflow.
isActivated	No	`true` once the user reaches your key milestone. Leave it out if you don't know yet.
anything else	No	Saved on the user as a property and shown on their profile.

Activation (isActivated)

Activation means a user got real value, for example created their first project. You decide what that moment is.

When isActivated changes to true, Atlis sends the Onboarding completed email (if that workflow is on) and stops the Not activated in 48h workflow for that user.
New users start as not activated.
Don't send isActivated: false on every page load. It overwrites a true you sent earlier. Send it only when you know the real value.
Other ways a user gets marked activated: a first payment through Stripe or Paddle, or a CRM status you mapped to Activated (see CRM status mapping).

Milestone workflows you picked during onboarding (like Created first project or Finished onboarding) also count a user as active for their lifecycle stage and health score when that event arrives. Workflows such as Payment failed or Inactive for a week never count as activation. They don't change isActivated itself, so the Not activated email can still send. Send isActivated: true to stop it.

Where to find these values

Auth tool	id	email	name
Firebase Auth	`user.uid`	`user.email`	`user.displayName`
Supabase	`user.id`	`user.email`	`user.user_metadata.full_name`
Clerk	`user.id`	`user.primaryEmailAddress.emailAddress`	`user.fullName`
Auth0	`user.sub`	`user.email`	`user.name`
NextAuth / Auth.js	`session.user.id` (add it in your session callback)	`session.user.email`	`session.user.name`
Your own database	Primary key of the users table	Email column	Name column

Install the tracking snippet

Track events