Installing Atlas
Last updated January 17, 2024
Forward Email
First, let’s forward email from your support email address to your Atlas support inbox . You can do this from Gmail settings here forwarding to this email.
[your-inbox]@inbox.getatlas.io
Note: when you add the Atlas support inbox address as a forwarding address, you’ll need to get the verification code; you can find this in the Atlas inbox.
Install Snippet
Next, let’s install the snippet to on your website. Add this to the <head>
tag of each page you want it to show up on.
<script>
(()=>{"use strict";const t={appId:"YOUR-APP-ID",q:[],identify:function(t){this.q.push(["identify",t])}};window.Atlas=t;const e=document.createElement("script");e.async=!0;e.src="https://app.getatlas.io/client-js/atlas.bundle.js";const s=document.getElementsByTagName("script")[0];s.parentNode?.insertBefore(e,s)})();
</script>
Additionally, you’ll want to setup user identification, typically on pages where a user is behind a login:
window.Atlas.call("identify", {
userId: "User Id",
name: "User Name",
email: "User Email",
fields: {
"title": "",
"department": "",
"photo": "",
"accountName": "",
"phone": "",
"street1": "",
"street2": "",
"city": "",
"country": "",
"postalCode": "",
"secondaryEmail": "",
},
"customFields": {
"tier": "free",
"type": "chat",
"isGuest": true,
"mrr": 1000
},
})
Remaining Setup
For the remaining configuration, see the other tabs in App Configuration, such as Chat (setup your chat widget colors, messages, away hours, and logo), Session Recording (if you’re capturing sessions on your marketing pages, be sure to Enable “Session recording for visitors”), and Slack (sign into Slack to receive Slack messages when users send you a message).
Test
Now let’s give it a test run: go to your homepage and send a chat to see if it works. You should be able to see if it works!