Gmail (Developer App)

Private and secure email by Google at no cost, for business and consumer accounts. Use this app to connect your own developer account credentials.

Go to site
Gmail (Developer App)

Gmail (Developer App) API Integrations

Build and run workflows using the Gmail (Developer App) API. Use 1000s of source-available triggers and actions across 1400+ apps. Or write custom code to integrate any app or API in seconds.


By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the 900+ apps that are available on Pipedream.

import { axios } from "@pipedream/platform"
export default defineComponent({
  props: {
    gmail_custom_oauth: {
      type: "app",
      app: "gmail_custom_oauth",
  async run({steps, $}) {
    return await axios($, {
      url: ``,
      headers: {
        Authorization: `Bearer ${this.gmail_custom_oauth.$auth.oauth_access_token}`,

Choose an API to Connect with Gmail (Developer App) API

apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Trigger workflows on an interval or cron schedule.
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular apps like ChatGPT and DALL·E 2.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Pre-built actions to make formatting and manipulating data within your workflows easier.
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.

Getting Started

The Google Developer App in Pipedream can integrate with either a personal Gmail account or a Google workspace email account. Either option involves creating a custom Google App in the Google Cloud Console. This process does not involve any code or special approval by Google. The steps are outlined below:

Creating a Gmail app

In order to connect your personal or workspace Gmail account to Pipedream, you'll need to create a custom OAuth app in Google Cloud.

  1. Sign in to the Google Cloud Console
  2. Select an existing project or create a new one

Select an exisiting project or create a a new one in the Google Cloud Console

  1. Select APIs & Services
  2. Click Enable APIs & Services

Select "Enable APIs & Services to open a menu to enable the Gmail API for Pipedream to connect to

  1. Search for and select Gmail API
  2. Click Enable

Search for an select the Gmail Enterprise API

  1. Click OAuth consent screen on the left side

Click "OAuth consent screen" in the left navigation menu

  1. Select External User Type and click “Create”

Select "External" in the OAuth Consent Screen

  1. Fill in the required fields and click Save and Continue
  2. Click Add or remove scopes and select the scope and then click "Update"
  3. Click Save and Continue to finish the Scopes step
  4. Add your own email as a Test User by clicking *Add Users& then typing in your email in the prompt then clicking Add again. Then finally click Save and Continue to finish the Test Users portion.
  5. You should be prompted with a Summary page.

Now you've created an unlisted Gmail App that you can integrate with Pipedream.

Create OAuth Credentials

You will need to generate a set of OAuth credentials to connect your new Gmail app to Pipedream properly.

  1. Navigate to the Credentials section on the left side.

    Open the Credentials menu in the left hand nav bar

  2. Click Create Credentials at the top and select “*OAuth client ID

Click create credentials to start the process

Select the OAuth Client ID option

  1. Select Web application for Application type

Web application is the type of OAuth credential we're generating

  1. Name the app “Pipedream”
  2. Click Add URI and enter

Add the Pipedream URL to the Callback Redirect URL option

  1. Click Create to create your new OAuth keys
  2. Note the client ID and client Secret, but keep these private and secure

Store the Client ID and Client Secret keys

Connect your Gmail app Pipedream with your Gmail app OAuth crendentials

At this point, you should have a Gmail App under your Google Project, and a set of OAuth keys.

  1. Now when prompted in Pipedream after trying to connect a Gmail Developer App, copy and paste your OAuth credentials.

  2. Also select the scopes you chose when defining the app. We recommend using

  3. Then click Connect

  4. If you did not publish your Gmail App in the Google Cloud Console, just click Continue to ignore the warning.

    Click continue if presented with a warning about an unpublished app

  5. Check all of the necessary scopes you'll need for your workflows

    Check all scopes to include grant your integration permission

  6. Click the final Connect and your custom Gmail app should be integrated into Pipedream!

Add Label to Email with Gmail (Developer App) API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Gmail (Developer App)
Try it
Send Message (Advanced) with Discord Webhook API on New Email Received from Gmail (Developer App) API
Gmail (Developer App) + Discord Webhook
Try it
Add Label to Email with Gmail (Developer App) API on New Message in Channel from Discord Bot API
Discord Bot + Gmail (Developer App)
Try it
Add Label to Email with Gmail (Developer App) API on New Submission from Typeform API
Typeform + Gmail (Developer App)
Try it
Add Label to Email with Gmail (Developer App) API on Custom Events from Zoom API
Zoom + Gmail (Developer App)
Try it
New Attachment Received from the Gmail (Developer App) API

Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.

Try it
New Email Received from the Gmail (Developer App) API

Emit new event when an email is received. This source is capped at 100 max new messages per run.

Try it
New Labeled Email from the Gmail (Developer App) API

Emit new event when a new email is labeled.

Try it
New Sent Email from the Gmail (Developer App) API

Emit new event for each new email sent. (Maximum of 300 events emited per execution)

Try it
Add Label to Email with the Gmail (Developer App) API

Add a label to an email message. See the docs

Try it
Create Draft with the Gmail (Developer App) API

Create a draft from your Google Workspace email account

Try it
Download Attachement with the Gmail (Developer App) API

Download an attachment by attachmentId to the /tmp directory. See the docs

Try it
Find Email with the Gmail (Developer App) API

Find an email using Google's Search Engine. See the docs

Try it
Send Email with the Gmail (Developer App) API

Send an email from your Google Workspace email account

Try it


Gmail (Developer App) uses OAuth authentication. When you connect your Gmail (Developer App) account, Pipedream will open a popup window where you can sign into Gmail (Developer App) and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail (Developer App) API.

Pipedream requests the following authorization scopes when you connect your account:

do not use
OAuth Request Configurations:
  1. authorization
    GET{{custom_fields.client_id}}&state={{oauth.state}}&redirect_uri={{oauth.redirect_uri}}&response_type=code&scope=email profile {{custom_fields.space_separated_scopes}}&access_type=offline&prompt=consent
  2. accessToken
    POST application/x-www-form-urlencodedaccept: application/json
  3. refreshToken
    POST application/x-www-form-urlencodedaccept: application/json