1. During the last step of organization onboarding, you will receive unique ORG_TOKEN for your organization.
  2. Copy the script tag below and paste it at the top of the <head></head> tag in your web app HTML
index.html
<script id="overhyped-ai-script" type="text/javascript" src="https://overhypedcdn.blob.core.windows.net/oai-connect/prod/main.js" async></script>
  1. Integrate OverhypedAI into your web app

Installing OverhypedAI connect using NPM or Yarn

npm install @overhyped-ai/connect

Importing and using OverhypedAI widget in your web app

Once you have installed the package using NPM or Yarn, you can import OverhypedAI using the code below

import OverhypedAI from '@overhyped-ai/connect/OverhypedAI';

Sample Usage:

import OverhypedAI from '@overhyped-ai/connect/OverhypedAI';

// Assuming that onMount is called on first render
const onMount = () => {
    OverhypedAI("initOrg", <ORG_TOKEN>, {
        autoConnect: false
    })
}

// Assuming that onLogin is called once user login to your webapp
const onLogin = () => {
    OverhypedAI(
        "initUser",
        { type: "email", value: "name@company.com" },
        {
            subscriptionPlan: "Free Trial",
            firstName: "John",
            lastName: "Doe",
            role: "User Role",
            company: "User Company",
            userCreatedAt: "2025-11-15T09:00:00.000Z",
        }
    )
}

// Assuming that onShow is called once user login to your webapp and onLogin is called.
const onShow = () => {
    OverhypedAI("connect")
}

// Assuming that onHide is called whenever you want to disconnect the user. Ex: onLogout
const onHide = () => {
    OverhypedAI("disconnect")
}

Methods

A detailed description of the methods available for integrating the Widget.