Set up Gmail with Nango

Register an OAuth app with Gmail and connect it to Nango

This guide shows you how to register your own app with Google to obtain your OAuth credentials (client ID & secret). These are required to let your users grant your app access to their Gmail account.

You will need to pass a security review to go live with your integration.

Follow our guide to get approved as fast as possible.

Create your OAuth App

1. Create a Google Cloud account

   If you don’t already have one, sign up for a Google Cloud account.

2. Create a new project

   1. Go to the Google Cloud Console.
   2. Click on the project dropdown at the top left of the page.
   3. Click New Project.
   4. Enter a Project Name for your project.
   5. Under Location, select the appropriate organization or folder where this project should belong.
      If you’re not part of an organization, it will default to No organization
   6. Click Create and wait for the project to be created.
   7. Select it from the project dropdown.
3. Enable the APIs you need

   1. Go to the API Library in the Google Cloud Console.
   2. Search for Gmail API and select it, then click Enable.
4. Configure the OAuth consent screen

   1. Go to APIs & Services > OAuth consent screen in the Google Cloud Console.
   2. Click Get started.
   3. Fill in the App Information form.

   • App Name: The name of the app asking for consent.
   • User support email: For users to contact you with questions about their consent.

   4. Click Next. Select the appropriate Audience:
      • External: For applications available to any Google user
      • Internal: For applications restricted to users within your Google Workspace organization
   5. Click Next. Fill in the Contact Information; these are the email addresses that Google will use to notify you about any changes to your project.
   6. Click Next, then check the I agree to the Google API Services: User Data Policy checkbox, and click Continue.
   7. Add the scopes your application needs. Under Data Access, click Add or Remove Scopes and select the scopes that correspond to the APIs you enabled.
   8. Under Audience, click Add users if you selected External user type (required for testing before verification).
5. Create OAuth 2.0 credentials

   1. Go to APIs & Services > Credentials in the Google Cloud Console.
   2. Click Create Credentials and select OAuth client ID.
   3. Select Web application as the application type.
   4. Enter a name for your OAuth client.
   5. Under Authorized redirect URIs, add https://api.nango.dev/oauth/callback.
   6. Click Create.
   7. A dialog will appear with your client ID and client secret. Save these credentials securely as you’ll need them when configuring your integration in Nango.
6. Start building your integration

   Follow the Quickstart to build your integration.

7. Verify your app

   Most Gmail scopes are marked “sensitive” or “restricted” by Google. You can develop in test mode, but you need to pass a security review to go live.

   Follow our guide to prepare and pass as quickly as possible.

8. Publish your app (switch from Testing to Production)

   To move your OAuth app from testing to production:

   1. Go to APIs & Services > OAuth consent screen > Audience.
   2. Click Publish App to switch your app from testing to production.

OAuth Scopes

Select only the scopes your app needs. See Google’s OAuth 2.0 Scopes documentation for the full list. For Gmail OAuth details, see the Gmail API documentation.

---