Installing AtomChat on Invision Power Board (Cloud)

Before you begin

1. Signup for a free trial (if you haven't already)

First select a plan from the AtomChat Free Trial page, enter your email address and start your free trial.

2. Note your API keys

Sign in to your AtomChat Client Area and click on the Manage button and then note down the keys present in API Keys (top right button) section - API Key, Auth Key, License Key and App ID. You may need these during installation.

3. Secure your environment

For successful integration, please ensure your domain or local environment is SSL certified and secure.

AtomChat Admin Panel
AtomChat Admin Panel

Choose a layout

AtomChat offers 2 layouts

1. Docked Layout creates a floating chat widget at the bottom right/left corner of your website. 2. Embedded Layout embeds a chat interface inside any page of your website.

And please remember!!

AtomChat layouts are not designed to be used together on the same page. If you add both layouts on the same page, please expect erratic behaviour from the software.

Setting up Docked Layout

                   Docked Layout
Docked Layout

Please copy the code given below and replace APP_ID and AUTH_KEY with your unique keys.

Then follow the instructions given in the section - "Where to add this code?"

JS

ATTENTION

In the code snippet above, make sure to replace 'APP_ID' with your App ID and 'AUTH_KEY' with your Auth Key.

Where to add this code?

  • Login to your IPB AdminCPCustomization sectionSelect Themes → In front of your default theme, click on "Edit HTML and CSS" icon (refer following screenshot for the same).
Document image
  • The "globalTemplate" will get opened. Scroll down to bottom and the above docked layout code right before the closing </body> tag and save the globalTemplate.

You can learn more about how to modify your template in the IPB Documentation.



Setting up Embedded Layout

               Embedded Layout
Embedded Layout

Please copy the code given below and replace APP_ID and AUTH_KEY with your unique keys.

Then follow the instructions given in the section - "Where to add this code?"

JS

ATTENTION

In the code snippet above, make sure to replace 'APP_ID' with your App ID and 'AUTH_KEY' with your Auth Key.

Where to add this code?

  • Paste the the above code in any page of your site where you want Chat to appear. You can add above code in existing pages or you can create new page and add code there.
  • Where you can find pages on your site -
  1. Login to your IPB AdminCPPages sectionSelect Pages
  2. If you wanted to add embedded layout in existing page, the edit that existing page and add the above code under "Content" section.
  3. If you wanted to create new page for chat, then with "Add Page", you can create new page and add the above code under "Content" section.
Document image

Contact Sync

Your users will be visible on the contact list once they log in using their credentials again to the site after installation.

Security

IMPORTANT

Before you go live, follow our security guide to ensure your integration is secure.

Jump to Security Guide

Congrats!! You are all set to start using AtomChat!