Google G Suite integration

Getting Started

Amity integrates with Google G Suite (formerly called Google Apps).

Amity can import email messages and store them as engagements. Once enabled, the integration will check for new messages every hour.

 

Step 1: Provide your email domain

Provide the email domain of your Google G Suite account to your Amity Customer Success manager.

The email domain is the portion of your email address that follows the @ symbol. For example, if your email address is jane@yourcompany.com, then the email domain is yourcompany.com.

 

Step 2: We'll install your Google G Suite integration

Once we have received your email domain, a member of Amity's Customer Success team will install and enable the Google G Suite integration on your behalf.

 

Step 3: Allow Amity to access your email

Before Amity can retrieve an email, you must grant us permission to your mailbox.

1. Login to Amity.

2. Click your avatar image in the top right corner.

3. Click My Profile.

4. Click the Authorize button.

5. Click on the account that has the same email as your Amity user.

6. Click the Allow button.

7. To deauthorize Gmail from connecting to Amity, click the Deauthorize button.

 

Important: Every Amity user who wants the Google G Suite email integration must perform Step 3. 

 

Administrator Consent Method

The administrator consent access method uses a Google service account to access email in your company's Gmail system. The benefit of this method is that each user does not need to
individually consent to get up and running.

Part 1: Enable API Access

1. Log into https://admin.google.com.

2. Click the Security icon in the Admin console section.  If you do not see the Security icon, click on the More Controls button at the bottom of the page.

3. Click API reference.

4. Look for the API access section. Select the Enable API access check box.

5. Click the Save button.

 

Part 2: Grant API client access to Amity's service account

1. Scroll down and click Show more.

2. Click Advanced settings.

3. Look for the Authentication section.  Click Manage API client access.

4. Copy the following value into the Client Name field:

303054567953-f5jtb6n089emgu4fg4g03oa1dg2030fa.apps.googleusercontent.com

This value is the unique client name that Google created for Amity's service account.

5. Copy the following API scopes into the One or More API Scopes field:

 https://www.googleapis.com/auth/gmail.readonly
 https://www.googleapis.com/auth/userinfo.email
 https://www.googleapis.com/auth/userinfo.profile

 

6. Click Authorize.

The final result will look like this:

 

Part 3: Provide administrator email address

Provide the email address of your G Suite system administrator to your Amity Customer Success Manager.

 

Legacy Access Method (IMAP)

The legacy access method uses a Google service account to access email in your company's Gmail system using IMAP.

This method is supported for legacy customers and is not recommended for new Amity customers.

 

Part 1: Enable IMAP access

1. Log into https://admin.google.com.

2. Go to Apps > G Suite > Gmail > Advanced Settings

3. Type IMAP in the search field.

4. In the "POP and IMAP Access" section, clear the check box for Disable POP and IMAP access for all users.

5. Click the Save button.

It may take up to one hour for IMAP and POP changes to take effect.

For more details, refer to this article in Google's G Suite Administrator Help. 

 

Part 2: Enable API Access

1. Log into https://admin.google.com.

2. Click the Security icon in the Admin console section.  If you do not see the Security icon, click on the More Controls button at the bottom of the page.

3. Click API reference.

4. Look for the API access section. Select the Enable API access check box.

5. Click the Save button.

 

Part 3: Grant API client access to Amity's service account

1. Scroll down and click Show more.

2. Click Advanced settings.

3. Look for the Authentication section.  Click Manage API client access.

4. Copy the following value into the Client Name field:

303054567953-f5jtb6n089emgu4fg4g03oa1dg2030fa.apps.googleusercontent.com

This value is the unique client name that Google created for Amity's service account.

5. Copy the following API scopes into the One or More API Scopes field:

https://mail.google.com/,https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.directory.user.readonly

6. Click Authorize.

The final result will look like this:

 

Part 4: Provide administrator email address

Provide the email address of your G Suite system administrator to your Amity Customer Success Manager.

 

Troubleshooting IMAP

IMAP must be enabled in order for Amity to successfully retrieve email from a Gmail account.

1. Open Gmail.

2. In the top right, click Settings (Gear) button.

3. Click Settings.

4. Click the Forwarding and POP/IMAP tab.

5. In the "IMAP Access" section, select Enable IMAP.

6. Click Save Changes.

 

Limitations

1. Google does not provide IMAP or REST API access to Google Groups.  As a result, Amity cannot access emails in groups. However, if you sync the mailbox of any user that belongs to a group, Amity will have access to group emails in the user's mailbox.
2. Email messages can consist of multiple parts. Each part has a type. The types are plain text, HTML text, and binary file attachments (photos, documents, spreadsheets, etc.). Amity does not parse HTML text or binary attachments. If the email only contains an attachment or HTML text, the message body will appear empty in the Amity engagement. This limitation is rarely a problem because the vast majority of email applications will generate both plain text and HTML text whenever a message is created.