Installing AtomChat on Moodle

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?

  1. Login as Admin to your Moodle site.
  2. Add the above code in additional html footer, which you will find in Site Administration → Appearance → Additional HTML → Add the code in “Before BODY is closed”
  3. Save Changes and check on your site.



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?

Open the page where you want to add embedded layout or create a page in your Moodle application and paste the above code.

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 oour security guide to ensure your integration is secure.

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