Whitelabel domain: the agent on your own domain
A whitelabel domain puts the Rapidflare agent on a domain that belongs to your company, for example ask.yourcompany.com. Anyone who opens that URL gets a full page with only your agent, in your branding. Rapidflare hosts the page, so there is nothing to install on your website. On this page we call https://ask.yourcompany.com (or whichever name you pick) your agent URL.
People open your agent URL and get the agent in the whole browser tab, with your branding.
What your visitors will see
- Your own domain in the browser bar, for example
ask.yourcompany.com. - A full page that is only your agent. They type a question, get an answer and keep chatting.
- No pop-up and no chat bubble. The agent is the whole page.
- If you also show it inside one of your own pages (see below), it looks like part of that page.
Set it up on your domain
Rapidflare sets this up with you. It is not in the dashboard yet.
- Choose a name. Pick a name under your company's domain, for example
ask.yourcompany.comorsupport.yourcompany.com. This becomes your agent URL. - Tell us. Email support@rapidflare.ai, or contact your Rapidflare account team, with the name you chose.
- Point the domain to Rapidflare. We send you a few DNS records. They tell the internet that this name should open your Rapidflare agent. Whoever manages your domain, such as your IT team or your web host, adds them.
- Check it. Once the records are working, open your agent URL in a private window. You should see your agent.
Share it as a link
Use your agent URL like any other link: in an email, as a button or menu item on your website, in a help article or on a printed handout. Anyone who opens it gets your agent on a full page. Most teams use it this way.
Or show it inside one of your pages
You can also show the agent inside a page of your own site, as a box that looks like part of the page. This uses an iframe: a box on your page that shows another page, here your agent URL.
The agent fills a box inside your page, like any other part of it. Your menu and the rest of the page stay around it.
Copy this and put your agent URL in place of https://ask.yourcompany.com. You can paste it into any page that accepts an HTML block, such as a WordPress "Custom HTML" block.
<!-- Put your agent URL in src -->
<iframe
src="https://ask.yourcompany.com"
title="Rapidflare"
style="width: 100%; min-height: 500px; border: none; outline: none; box-shadow: none;"
allow="microphone; midi; encrypted-media; autoplay; accelerometer; fullscreen; gyroscope; usb; magnetometer; clipboard-read; clipboard-write; picture-in-picture; web-share"
></iframe>
min-height sets how tall the box is. The allow line lets the agent use things like the microphone and full screen. Keep it as it is.
Use an iframe only for your agent URL
Do not paste the chat code from the other widget pages into a website builder's "HTML embed", "Embed code" or iframe block. That code runs inside a frame there and does not work properly. See Add Rapidflare to a website builder.
Choose how it starts
You can add a few settings to the end of your agent URL to change how the agent opens. They work both for the link and for the iframe. Put ? before the first setting and & between settings.
| Add to the end of your agent URL | What it does |
|---|---|
prompt=Your%20question | The agent opens with that question already typed. In a URL, a space is written %20. |
autoSubmit=true | Used together with prompt: the agent answers the question right away, without the visitor pressing send. |
theme=dark | Dark colors. Light is the default. |
For example, this URL opens the agent in dark colors and answers "How do I reset my password?" right away:
https://ask.yourcompany.com?theme=dark&prompt=How%20do%20I%20reset%20my%20password%3F&autoSubmit=true
These settings only change the agent, not the page around an iframe.
If something does not work
| What you see | Why it usually happens | What to do |
|---|---|---|
| Your agent URL does not open | The DNS records are not added yet, or they are still spreading across the internet, which can take a while | Ask whoever manages your domain to add the records Rapidflare sent. If it still does not open the next day, email support@rapidflare.ai. |
| The agent inside your page is too small | The iframe box is not tall enough | Raise the min-height number in the iframe snippet, for example to 700px. |
| The microphone or full screen does not work inside your page | The iframe is missing its allow line | Copy the full iframe snippet above, including the allow line. |
| You pasted chat code into an embed block and nothing shows | Embed blocks put code inside a frame, where the chat code does not work | Use the iframe above with your agent URL. For the chat button or a search bar, see the website builder guides. |
For developers: URL parameters
Every setting you can add to the agent URL, as query parameters after ?, joined with &. They work when the URL is opened directly and when it is the src of an iframe. Values must be URL-encoded.
| Parameter | Type | What it does |
|---|---|---|
prompt | string | A question to start with. URL-encode it. |
autoSubmit | true or false | With prompt, true sends the question as soon as the page loads. |
theme | light or dark | The agent's colors. Light is the default. |
userId | string | The signed-in visitor's id, email recommended. Leave it out for signed-out visitors and the page uses an anonymous id. Never send one fixed value for everyone. See Identifying your users. URL-encode it. |
context | string (JSON) | The page the visitor came from, and anything else useful, as URL-encoded JSON in the same shape as the Embed SDK context. |
Building the URL in JavaScript handles the encoding for you:
<iframe
id="rf-whitelabel"
title="Rapidflare"
style="width: 100%; min-height: 500px; border: none; outline: none; box-shadow: none;"
allow="microphone; midi; encrypted-media; autoplay; accelerometer; fullscreen; gyroscope; usb; magnetometer; clipboard-read; clipboard-write; picture-in-picture; web-share"
></iframe>
<script>
// Put your agent URL here
const url = new URL('https://ask.yourcompany.com');
url.searchParams.set('theme', 'light');
url.searchParams.set('prompt', 'How do I reset my password?');
url.searchParams.set('autoSubmit', 'true');
document.getElementById('rf-whitelabel').src = url.href;
</script>
Other ways to show the agent
Every widget type has its own page. Compare all of them or jump to another one.
A chat bubble in a corner of every page. Visitors click it and the agent opens as a popup.
The agent inside a page you own. Also where a search or an AI overview continues.