Put helpful guidance right inside your product.

1. Create your installation

Sign in to your AskRevan organization. Open Website tools → Website setup, create an installation, enter the exact HTTPS origin of your website (for example, https://admin.cornerleague.com), and publish only approved SOPs. Copy the generated ar_pub_... key.

The public key identifies the installation. It is safe to embed in the browser but does not authorize private workspace data. Do not put backend secrets in frontend code.

2. React installation

Install @askrevan/embed-react from npm; its SDK dependency is included. Use a published version and mount the widget once.

import { AskRevanWidget } from "@askrevan/embed-react";

export function SupportAssistant() {
  return <AskRevanWidget
    apiUrl={import.meta.env.VITE_ASKREVAN_API_URL}
    publicKey={import.meta.env.VITE_ASKREVAN_PUBLIC_KEY}
    supportUrl="https://your-company.example/support"
  />;
}

Mount the component once in the authenticated site's root layout or app shell. For a Next.js integration, use a client component and the appropriate NEXT_PUBLIC_ variables rather than Vite's import.meta.env.

3. Vanilla JavaScript

Use the official hosted browser script. Copy the installation-specific snippet from Embed Studio, which automatically includes your public key and API URL. Paste it once near the end of your site body.

<script src="https://askrevan.com/sdk/askrevan-embed.iife.js" defer></script>
<script>
window.addEventListener("DOMContentLoaded", () => {
const widget = new window.AskRevanEmbed({
  publicKey: "ar_pub_REPLACE_WITH_YOUR_INSTALLATION_KEY",
  apiUrl: "https://YOUR_ASKREVAN_API/v1",
});
widget.mount();
});
</script>

Website testimonials

In Website tools → Feedback, create a testimonial request, optionally collect a public 1–5 rating, and choose a quote wall, manual carousel or compact trust strip. Publish the settings, then separately approve and publish individual testimonials.

Copy the campaign-specific React or JavaScript embed from Studio into the customer-stories section of your website. It reuses your installation and can run without the floating help widget. React users need @askrevan/embed-react@0.1.7 or newer.

These are moderated customer testimonials. Counts include published testimonials only; averages use explicitly consented public ratings. Existing quote-only consent and private survey ratings stay separate. Contributors can withdraw permission using their private receipt.

Optional: resume across devices

Basic installation needs only the public key and API URL. For signed-in visitors who should resume walkthroughs on another device, an owner or admin can enable cross-device progress in the installation settings.

In Embed Studio, open Optional backend visitor identity and create an installation-specific backend key. Store it only on your server. Your authenticated backend sends a stable opaque visitor ID to POST /v1/embed/visitor-token/:publicKey using the key as a Bearer credential. It receives a short-lived visitor token; supply it to the widget with syncProgress={true}. Derive role and plan from trusted server data. Never share the platform signing secret or expose the backend key in frontend environment variables.

Refresh visitor tokens before their five-minute expiry, and unmount/reset the widget on logout or user change. Saved progress is private to that visitor and installation, expires after 30 days without a save, and includes the visited walkthrough path. Competing saves require an explicit refresh. Outages leave guidance available locally; only confirmed saves can be resumed on another device. Completion is user-reported guidance, not proof of a business action.

The guide list offers Refresh saved progress and a confirmed Clear saved progress action. Anonymous visitors keep tab-local progress. Enable this optional feature only after your backend integration and two-device acceptance checks pass.

4. Authentication & publishing

By default, published guides are intended for visitors to the allowed origins. Review each step and screenshot before publishing. Never publish passwords, private recording URLs, customer identifiers, or internal-only SOPs.

For restricted audiences, enable signed visitor tokens only after the server-side signing secret and token-delivery flow are configured. Generate tokens on a trusted backend, use short expiry, and validate access on the API. A public key and an Origin header are not proof of user identity.

Use a separate installation for staging and production. Owners and admins can disable an installation or rotate its public key inside Embed Studio. Rotation immediately requires updating the site's key; any already-loaded widget may remain visible until reloaded.

5. Troubleshooting

Widget does not load

Check the public key, API URL, browser console, API availability, and exact scheme/hostname/port on your allowed origins list.

No guides appear

Confirm the SOP is published in the correct organization and explicitly enabled for this installation.

Walkthrough can't find a button

Check the published step's page path and stable CSS selector. Avoid generated class names that change between builds.

Images do not appear

Check that each media URL was reviewed and intentionally made publicly accessible through HTTPS. Private recording assets are not automatically published.

Visitor authorization fails

Check server signing configuration and the token audience/expiry; never mint visitor tokens in browser JavaScript.