New: no-code event targeting is live. See how →
Onbixo
Skip to content

Install Onbixo

Onbixo installs with a single script tag. Once it is on your site, every flow you build and publish goes live automatically - no redeploy needed.

Add the snippet

In the dashboard, open Install from the sidebar. You will find your install snippet and your API key. Copy the snippet and paste it into your app, just before the closing </body> tag on every page where you want flows to run:

<script>
  window.onbixo = window.onbixo || [];
  window.onbixo.push(["init", {
    account: "YOUR_ACCOUNT_ID",
    token: "YOUR_API_KEY",
    apiBase: "https://api.onbixo.com"
  }]);
</script>
<script async src="//cdn.onbixo.com/onbixo.js"></script>

Replace YOUR_API_KEY with the key shown on the Install page - that is the whole install. The async script never blocks your page, and onbixo.push([...]) works the same whether or not the runtime has loaded yet - calls made early are queued and run in order once it does. Use it for every API method too, e.g. onbixo.push(["identify", "user-123"]).

Note

The runtime loads asynchronously, so it never blocks your page. If Onbixo is ever unreachable, your app keeps working and flows simply do not show - the runtime is built to fail safe.

Identify your users (optional, but recommended)

If you tell Onbixo who the current user is, you unlock targeting by user and company traits, and flows can remember what each user has seen across devices. Call identify once you know who is logged in:

onbixo.push(["identify", "user-123", {
  name: "Ada Lovelace",
  plan: "pro",
  signupDate: "2026-01-04"   // reserved - see below
}, {
  companyId: "acme",
  employees: 40
}]);

You control exactly what you send, with one exception: signupDate is read by name to power days-since-signup targeting. Send it as an ISO date like "2026-01-04" or a millisecond timestamp. Anything we cannot parse is ignored without an error, so a Unix timestamp in seconds or an ambiguous "04/01/2026" will quietly target the wrong window.

Leaving it out is fine - we fall back to the first time that browser loaded a flow. That reads a brand-new signup correctly, but it is per-browser, so the same person on a second device looks new again, and anyone who signed up before you installed Onbixo looks new on their next visit.

See the Runtime API for the full method reference, and Targeting for how traits are used.

Verify it is working

  1. Publish a simple flow (see Build your first flow).
  2. Open your app in a browser and visit the page the flow targets.
  3. The flow should appear. If it does not, check Troubleshooting.

Allowed origins

For security, your API key only serves flows on the domains you approve. Add your app's domain(s) on the Install page so the runtime is allowed to load your flows there. Requests from other origins are rejected.

Tip

Building the flow visually by clicking elements on your live app? Use the browser extension - it captures robust selectors for you.

Last updated: Sep 14, 2026

Was this page helpful?
Still need help? We're happy to lend a hand. Contact us