Runtime API

The runtime exposes a small JavaScript API on window.onbixo. Use it to identify users, track events, and drive flows from your own code.

Setup

The install snippet loads the runtime asynchronously. Call every API method through onbixo.push([...]) - it works the same before and after the runtime loads (calls made early are queued and run in order once it does):

onbixo.push(["init", { account: "YOUR_ACCOUNT_ID", token: "YOUR_API_KEY", apiBase: "https://app.onbixo..." }]);
onbixo.push(["identify", "user-123", { plan: "pro" }]);
onbixo.push(["track", "signed_up"]);

Each method below is documented by its name and arguments. To call one, pass the method name first, then its arguments, to onbixo.push. For example the method identify(userId, traits, company) is called as onbixo.push(["identify", userId, traits, company]).

identify(userId, traits, company)

Tell Onbixo who the current user is. Unlocks trait-based targeting and lets flows remember progress across devices.

onbixo.push(["identify", userId, traits, company]);

Example

onbixo.push(["identify", "user-123", { plan: "pro" }, { companyId: "acme", size: 40 }]);

signupDate: the one reserved trait

Every other trait is yours to name. signupDate is read by name to power days-since-signup targeting, so the spelling matters - it is camelCase, and it goes in traits, not in company.

A value we cannot parse is ignored, silently. Days-since-signup then falls back to first-seen (below), so flows keep running but match against the wrong date rather than erroring. The two formats worth double-checking: a Unix timestamp in seconds resolves to 1970, and an ambiguous "04/01/2026" is read as month-first by most browsers.

If you never send signupDate, days-since-signup falls back to first seen - the first time this browser loaded a flow. That is a reasonable stand-in for a brand-new signup, but it is per-browser: the same person on a second device looks new again, and someone who signed up months before you installed Onbixo looks new on their next visit. Send the real date if the distinction matters to your flow.

track(eventName, properties)

Record a behavioral event you can then target on.

onbixo.push(["track", eventName, properties]);

Example

onbixo.push(["track", "created_project", { plan: "pro" }]);

show(flowId)

Manually open a flow whose trigger is set to "manual." Returns whether it was shown.

onbixo.push(["show", flowId]);

Example

onbixo.push(["show", 42]);

relaunch(flowId)

Replay a loaded flow on demand (this powers the resource center's relaunch rows). Tears down the current flow and starts the target, bypassing the "already dismissed" rule.

onbixo.push(["relaunch", flowId]);

Example

onbixo.push(["relaunch", 42]);

completeItem(flowId, itemId)

Mark a checklist item done from your app - use this for verified, not self-reported, completion.

onbixo.push(["completeItem", flowId, itemId]);

Example

onbixo.push(["completeItem", "flow-key", "item_1"]);

Flow controls