Back to connector

LogoGmail Integration Development Guide

Add white-label customer-facing integration with Gmail into your app with just a few lines of code.

How to set up GMail OAuth application and get your Client ID and Client Secret

Project Setup

  • Go to the Google API Console.
  • Create a new project (if you haven't already) by clicking on the "Select a project" drop down menu and selecting “New project”
  • Add necessary API’s from the Library (Gmail API)

In case you'd rather follow the official Google documentation, you can find it here.

Configure the OAuth application

  • Click on the OAuth consent screen item in the left sidebar
  • Choose the User Type = external
  • To be able to put your organization domain into the “Authorized domain” field, have it go through the Google Search console (to make sure it’s authorized and follow the authorization process in case it’s not authorized yet)
  • Add the following scopes:
    • https://mail.google.com/
    • https://www.googleapis.com/auth/gmail.metadata
    • https://www.googleapis.com/auth/gmail.settings.basic
    • https://www.googleapis.com/auth/userinfo.profile
    • https://www.googleapis.com/auth/userinfo.email
    • https://www.googleapis.com/auth/gmail.labels

Generate Credentials

  • Select Credentials > Create credentials > OAuth client ID.
  • Select Web application as the application type
  • Enter the URL of the the path where users will be redirected to after they have authenticated with Google in the Authorized Redirect URIs field: https://api.integration.app/oauth-callback
  • Click Create
  • Copy the Client ID and Client Secret from the dialog that appears

Note that if you want your app tp be accessible to other users outside of your organization, you may want to submit it for review. You can find more information about the process here