Gmail Logo

Gmail API Integration Profile

Information and guides about integrating with Gmail API

Add Gmail Integration to Your App

Configuration

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. IMPORTANT: should you want to get your app approved, you need to use custom redirect URI functionality and not mention integration.app anywhere in your app setup
  • Click Create
  • Copy the Client ID and Client Secret from the dialog that appears

Publish your app

Note that if you want your app to 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

Configure the app parameters in the integration.app platform

  • Add the Gmail app from store in the Integration.app console
  • Click Configure & Test
  • In the Parameters section, select a Use custom parameters toggle / Edit Parameters
  • Fill in Client Id and Client Secret
  • Add scopes your application may require

Testing

Supercharge your product integrations today