Before You Start
You need:- A created Brand Agent
- A tested customer-facing conversation flow
- Public/published visibility enabled
- Widget styling reviewed
Floating Chat Bubble
Use the floating chat bubble when you want the agent available across your site as a website chatbot.- Open your Brand Agent.
- Test the agent with realistic visitor questions.
- Open Publish.
- Choose the chat bubble/widget option.
- Copy the embed snippet.
- Paste the snippet into your website template, layout, or tag manager.
Identify Known Users with Contact ID
If your website or product already has logged-in users, pass your internal user or contact identifier withdata-contact-id. SketricGen stores this as the conversation contact_id, so conversations from the same person are grouped under the same contact in SketricGen.
Use a stable internal ID, UUID, or hashed value. Avoid sending emails, phone numbers, names, or other directly identifiable personal data as the contact ID.
If you do not know what internal user ID to use, skip this field. The widget still works without it.
Example for products with logged-in users:
data-contact-id. The widget will use its browser-stored anonymous contact behavior instead.
Developers can see the full identity model, including API, iframe, and fullscreen examples, in Public API: Contact ID and User Grouping.
Inline iFrame
Use an iframe when you want the agent embedded directly inside a page section.- Open your Brand Agent.
- Open Publish.
- Choose the direct embed or iframe option.
- Copy the iframe code.
- Paste it into the page where the chat should appear.
contactId query parameter:
Test After Deploying
After adding the widget:- Open the live page.
- Confirm the widget or iframe appears.
- Ask a question from your Brand Agent’s Knowledge Base.
- If you pass
data-contact-idorcontactId, confirm the conversation shows under the expected contact in SketricGen. - Test lead capture if enabled.
- Check the conversation in SketricGen.
data-agent-id or iframe URL uses the correct agent ID.
