Before you start
You need:- A published Blueprint that accepts a single text input (the visitor’s message) and returns a single text output (the reply).
- An AI provider connection configured under Integrations → AI providers.
- The domain(s) where you plan to embed the widget.
Step 1: Create the chatbot
Name and describe it
- Name — 3–120 characters. Shown in the widget header and in your chatbot list.
- Description — optional, up to 1,000 characters. Internal notes for your team.
Connect a Blueprint
Pick the Blueprint that will process each incoming message. Every visitor message becomes an input to that Blueprint chain, and the Blueprint’s final output is returned as the chatbot’s reply.
Choose an AI connection
Select the AI provider connection the chatbot should use by default for language model calls. You can use your own API key (BYOK) or a platform-provided connection.
Set visibility
- Private — only you can see and use the chatbot.
- Shared — accessible to members of your organization.
- Public — accessible to anyone with the embed code or direct link.
Step 2: Overview tab
The first tab after creation is Overview. Use it to confirm what you just configured and to find quick links you will need later.- Status — live, paused, or draft. Toggle the Active switch to take the chatbot offline without deleting it.
- Chatbot ID — the identifier you paste into your embed code. Click the copy icon next to it.
- Direct link — a hosted URL (
https://chat.iblueprint.io/c/YOUR_CHATBOT_ID) you can share without embedding. - Connected Blueprint — click to jump straight into the Blueprint editor.
- Recent activity — last 24 hours of messages, error rate, and average response time.
Step 3: Widget tab
The Widget tab controls how the chatbot looks and behaves in the floating widget.Branding and style
| Field | Description |
|---|---|
| Header title | Name shown at the top of the chat widget. |
| Welcome message | First message visitors see when the chat opens. |
| Placeholder text | Hint text shown inside the message input field. |
| Primary color | Accent color for buttons and highlights (hex code). |
| Logo URL | Brand logo, displayed in the widget header. |
| Position | Anchor the widget to bottom-right or bottom-left. |
| Show “Powered by iBlueprint” | Toggle the iBlueprint attribution badge on or off. |
Behavior
- Open on load — open the widget automatically when the page loads instead of waiting for a click.
- Persist conversations — keep the conversation history across page navigation in the same session.
- Typing indicator — show an animated indicator while the Blueprint is generating a reply.
- Suggested prompts — up to four starter prompts shown as clickable chips inside the welcome message.
Rate limiting
Cap how many messages a single visitor can send to prevent abuse:- Max messages per minute
- Max messages per hour
- Max messages per day
Step 4: Embed tab
The Embed tab gives you the code to drop into your site. There are two options.Script (floating widget)
Paste this snippet just before the closing</body> tag of any page where the widget should appear:
iframe (inline panel)
Embed the chatbot as a full-page or panel component:Step 5: Security tab
CORS rules
By default, iBlueprint restricts which domains can load the chat widget. Add an allowed origin for each domain where you plan to embed the chatbot.Add an allowed origin
Click Add origin and enter the full origin, including the scheme and port if non-standard:
Authentication
For chatbots that should only be accessible to logged-in users:- Signed embeds — generate a short-lived JWT on your backend and pass it to the widget via
data-auth-token. iBlueprint validates the token against the public key you upload here. - IP allowlist — restrict access to a list of CIDR ranges, useful for internal tools.
Content filters
Turn on built-in filters to block messages that contain profanity, PII, or prompt-injection patterns before they reach your Blueprint. Each filter logs a blocked event you can review in the Sessions tab.Step 6: Data capture tab
Data capture forms collect structured information from visitors during a chat session — for example, a name and email before the conversation starts, or a support ticket category mid-conversation.Name the form
Give it a descriptive name (for example, Lead qualification or Pre-chat contact info).
Define the schema
Add the fields you want to collect. Each field has:
- Name — the key the value is stored under.
- Type —
string,number, orboolean. - Description — guidance for the AI when it asks for the value.
- Required — whether the conversation can proceed without a value.
Configure question mode
Choose how the chatbot collects the data:
- Conversational — the AI asks one question at a time, in natural language.
- Structured — a form UI is rendered inside the chat with all fields at once.
Pick a trigger
- At conversation start — show the form before the first reply.
- Mid-conversation — fire when a Blueprint node emits a
request_captureevent. - On exit intent — show the form when the visitor tries to close the widget.
Step 7: Sessions tab
The Sessions tab is your log of every conversation the chatbot has had. Each session row shows:- Session ID and start time
- Visitor identifier (IP-derived by default, or your
data-user-idif signed embeds are configured) - Message count and total token usage
- Captured form data (if any)
- Final status — completed, abandoned, blocked, or errored
- Export the transcript as JSON or CSV.
- Replay the conversation against a different Blueprint version to test changes.
- Flag the session for review — flagged sessions are surfaced on the Overview tab.
Step 8: Analytics tab
The Analytics tab summarizes chatbot performance over a date range you pick.- Volume — messages, sessions, and unique visitors per day.
- Latency — average and p95 response time, broken down by Blueprint node.
- Cost — token spend by model and by node.
- Containment — percentage of sessions that ended without being escalated (handoff node fired).
- Feedback — thumbs-up / thumbs-down ratings visitors leave on individual replies.
Step 9: Versions tab
Every change you save to the chatbot’s settings creates a new version, mirroring how Blueprint and prompt versions work.- Diff any two versions to see what changed.
- Restore a previous version — the restore itself is recorded as a new version, so history is never rewritten.
- Pin a version as the live one. Until you pin, the latest saved version is the live one.
Step 10: Test and go live
Before you embed:- Open the chatbot’s direct link from the Overview tab and run through a real conversation.
- Check the Sessions tab to confirm the transcript and any captured data look correct.
- Watch the Analytics tab during your first day in production — keep an eye on the error rate and p95 latency.
