Put the chat on your website
This page lets you give visitors a way to reach your team: an inbox with its own chat page, and a chat button on your website that opens it.
Before you start
- You can manage Culpeo.
- You can add a line of HTML to your website, or you know who can.
- Your website is served over
https.
Add or change an inbox
Each inbox has a chat page of its own, which works without any website: send people its link from an email signature, a contact page or a QR code.
- Open Channels.
- Select Add channel.
- Type a Name and an Address. The address cannot be changed later.
- Select Add channel. The inbox appears in the list with its link under Reached by.
On the inbox's row, Copy copies the link. The row's actions menu holds Open chat page, to see what visitors see, and Rename.
To stop taking new conversations at an inbox, choose Close in the row's actions menu, then confirm with Close channel. Its address then tells newcomers that it is closed, and its open conversations carry on. Choose Reopen in the same menu to take conversations again.
Allow your website
The widget appears only on websites you list.
- Open Settings, then Website widget. Each inbox has its own card.
- Under Where it may appear, select Add an origin.
- Type your website's origin, such as
https://www.example.com. Add one row per website, up to 20. - Select Save widget. The card reads Embeddable.
An origin is the scheme and host only, with no path. It must start with https://, except http://localhost for testing. To allow every subdomain, write https://*.example.com.
Choose what visitors see
On the same card:
- Title: the name above the chat. Empty shows your company's name. The card's subtitle shows the name visitors see.
- Accent: a six-digit hex colour. Empty keeps your company's colour from Foxden Admin, or Culpeo's own.
- Mark: a PNG, JPEG or WebP image up to 256 KB. Empty keeps your company's logo from Admin.
- Launcher position: Bottom right or Bottom left.
- Email field: Optional, Required or Hidden. The address lets Culpeo email the visitor when someone replies, if email is set up on your server.
- Greeting, Intro heading, Intro body, Start button, Waiting line, Resolved line and Agent working line: the main words visitors read.
- More words: every other line visitors read, with Find a line to search them. Type in a field to replace its default, or leave it empty to keep the default.
Select Save widget. To see the result, select Open preview.
Add the snippet to your website
Under Install snippet, select Copy snippet. It is one line:
html<script src="https://your-culpeo-address/embed.js" data-inbox="support" async></script>Paste it anywhere in your page's HTML, on every page that should show the chat.
Open your website. A chat button appears in the corner you chose; it opens the inbox's chat in a panel, full screen on a phone.
Changes to the card reach your website within a minute. To open the chat from your own button, or put a question in it, see the embed guide.
What visitors see
Visitors give their name, and their email address when you ask for it, then write. They can attach up to 3 images. If they come back in the same browser within 30 days, they find their conversation again; New conversation starts another. Visitors never see internal notes, and they never see that a reply was typed in Slack.
Troubleshooting
No chat button appears
Check the browser's console:
- "data-inbox is missing or is not an inbox slug" means the
data-inboxvalue is not the inbox's address. - "the chat could not be shown on" your website means the website is not on the inbox's list. Add the exact origin under Where it may appear, save, and wait up to a minute.
The chat did not load.
The chat panel took too long to open. Select Try again in the panel. If it keeps failing, ask whoever runs the server whether Culpeo is reachable.
An origin is refused
Only https origins are allowed, apart from localhost. Remove any path, query or trailing part after the host.
Too many requests. Try again later.
Your server limits how many new chats can start in five minutes. If real visitors meet this, ask whoever runs the server; see Running Culpeo.