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
Explore
/
Apps
/
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 2,000+ apps. Or write custom code to integrate any app or API in seconds.

Overview

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.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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: `https://www.googleapis.com/oauth2/v1/userinfo`,
      headers: {
        Authorization: `Bearer ${this.gmail_custom_oauth.$auth.oauth_access_token}`,
      },
    })
  },
})

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

1
-
24
of
2,000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
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.
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 models like ChatGPT, DALL-E, and Whisper.
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Snowflake
Snowflake
A data warehouse built for the cloud
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
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.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.

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 https://mail.google.com/ 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 https://api.pipedream.com/connect/oauth/oa_G7Ain6/callback

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 https://mail.google.com/

  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!

Publish your custom Gmail app

Google has a 7 day expiration window on refresh tokens for applications with a publishing status of "Testing", so you will need to Publish your application in order to maintain your account connection.

  1. Navigate to your application, and click OAuth Consent Screen on the lefthand sidebar.
  2. Under Publishing status, click Publish App. If you included any sensitive or restricted scopes in your app, there will be a disclosure stating that you will need to go through the process of verification. Click Confirm.
  3. Your application will not be available externally unless you share your client_id with others, and you will not have to go through the verification process unless you intend to onboard over 100 users.
  4. The publishing status should be set to In production, and your account should maintain its connection without an expiration window.

Publish your application

Confirmation of changes

Add Multiple Rows with Google Sheets API on New Attachment Received from Gmail (Developer App) API
Gmail (Developer App) + Google Sheets
 
Try it
Create Note with Amplenote API on New Attachment Received from Gmail (Developer App) API
Gmail (Developer App) + Amplenote
 
Try it
Anything to PDF Converter with PDF.co API on New Email Received from Gmail (Developer App) API
Gmail (Developer App) + PDF.co
 
Try it
Send Email with Gmail API on New Email Received from Gmail (Developer App) API
Gmail (Developer App) + Gmail
 
Try it
Create Waiver Request with WaiverForever API on New Email Received from Gmail (Developer App) API
Gmail (Developer App) + WaiverForever
 
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

Troubleshooting

Application disconnects after 7 days
If your developer application disconnects after 7 days, you need to follow the steps above to Publish your custom Gmail app in order to keep your account connected.

Authentication

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
    GEThttps://accounts.google.com/o/oauth2/auth?client_id={{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
    POSThttps://oauth2.googleapis.com/tokencontent-type: application/x-www-form-urlencodedaccept: application/json
    client_id={{custom_fields.client_id}}&client_secret={{custom_fields.client_secret}}&grant_type=authorization_code&code={{oauth.code}}&redirect_uri={{oauth.redirect_uri}}
  3. refreshToken
    POSThttps://oauth2.googleapis.com/tokencontent-type: application/x-www-form-urlencodedaccept: application/json
    client_id={{custom_fields.client_id}}&client_secret={{custom_fields.client_secret}}&grant_type=refresh_token&refresh_token={{oauth.refresh_token}}