Gmail API Provider Setup

On this page

To authenticate a Gmail element instance you must create a project with a web application in the Google API console. After you create the project and app, Google provides a Client ID and Client secret which you will use to authenticate. You'll also need the Authorized redirect URI that you configure while creating the app.

When you set up your app, you must also enable the Gmail API.

If you've already set up an app and just need to know how to find your Client ID and Client secret, see Locate Credentials for Authentication. If you need to create a project and register an app, see Create an Application.

See the latest setup instructions in the Google API documentation.

Locate Credentials for Authentication

If you already created a project and application, follow the steps below to locate the Client ID, Client secret, and Authorized redirect URI. If you have not created an app, see Create an Application.

Note: Your app must have the Gmail API enabled. If not, see Enable APIs for more information

To find your OAuth 2.0 credentials:

  1. Log in to your account at Google.
  2. Click Select a project, choose your project from the list, and then click Open. Select Project

    Google displays your apps and associated Client ID.

  3. Click the pencil icon to see the Client ID, Client secret, and Authorized redirect URI.

  4. Record the Client ID and Client secret.

  5. Record the Authorized redirect URI for your app. Key secret and URL

Create an Application

If you have not already created a project and application, you need one to authenticate with Google. Creating an application is a multi-step process:

  1. Create a project
  2. Enable APIs
  3. Create a web application

Create a Project

To create a project:

  1. Log in to your account at Google.
  2. Click Select a project, and then click New Project.

    Create Project

  3. Accept the terms of service, and then complete the required information.
  4. Click Create.

Enable APIs

To make all of the requests available in the Gmail element, you must enable the GMail API.

To enable APIs:

  1. Select the project that you just created
  2. Click Enable APIs and Services.

    Enable APIs

  3. Search for and enable the Gmail API.

Create a Web Application

  1. Click Credentials on the left menu.

    Credentials

  2. Click the OAuth consent screen tab.
  3. Enter a Product Name and add any optional information, and then click Save.

    Consent

  4. Click Create Credentials, and then select OAuth Client ID.

    Credentials

  5. Select Web application as the Application type.
  6. Enter a Name and the Authorized redirect URI for your app. Record this as the OAuth Callback URL that you will need to authenticate.

    Client ID Page

  7. Click Create.
  8. Record the Client ID and Client secret to use when you authenticate. Key Secret and URL