Gmail

Private and secure email by Google at no cost, for business and consumer accounts.

Go to site

Gmail API Integrations

Build and run workflows using the Gmail API. Use 1000s of source-available triggers and actions across 1,600+ 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: {
      type: "app",
      app: "gmail",
    }
  },
  async run({steps, $}) {
    return await axios($, {
      url: `https://www.googleapis.com/oauth2/v1/userinfo`,
      headers: {
        Authorization: `Bearer ${this.gmail.$auth.oauth_access_token}`,
      },
    })
  },
})

Choose an API to Connect with Gmail API

1
-
12
of
1,600+
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.
Beta
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.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Beta
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 models like ChatGPT, DALL-E, and Whisper.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Discord
Discord
Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.
GitHub
GitHub
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.
Formatting
Formatting
Pre-built actions to make formatting and manipulating data within your workflows easier.
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.

Getting Started

To connect your Gmail account to Pipedream, just accept the prompt when connecting your Gmail account.

What's the difference between the Gmail app and the Gmail Developer App?

Google requires integration platforms such as Pipedream, to restrict the scopes users can enable for Gmail, in order to regulate the ability of users to build workflows and connect applications.

Currently, the Gmail app on Pipedream is limited to only sending emails on behalf of your Gmail email address associated with this app.

However, the Gmail Developer App is unrestricted because you have the ability to control the scopes through creating your own Google Cloud Project.

Because you can define your own scopes, you can read and write emails with your own Google Cloud Project. To learn how to create and authenticate a Gmail Developer App read our setup guide.

Send Email with Gmail API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Gmail
 
Try it
Send Email with Gmail API on New Message in Channel from Discord Bot API
Discord Bot + Gmail
 
Try it
Send Email with Gmail API on New Submission from Typeform API
Typeform + Gmail
 
Try it
Send Email with Gmail API on Custom Events from Zoom API
Zoom + Gmail
 
Try it
Send Email with Gmail API on New Submission (Instant) from Jotform API
Jotform + Gmail
 
Try it
Send Email with the Gmail API

Send an email from your Google Workspace email account

 
Try it

Authentication

Gmail uses OAuth authentication. When you connect your Gmail account, Pipedream will open a popup window where you can sign into Gmail 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 API.

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

emailprofilehttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.labels
OAuth Request Configurations:
  1. authorization
    GEThttps://accounts.google.com/o/oauth2/auth?client_id={{oauth.client_id}}&state={{oauth.state}}&redirect_uri={{oauth.redirect_uri}}&response_type=code&scope={{oauth.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={{oauth.client_id}}&client_secret={{oauth.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={{oauth.client_id}}&client_secret={{oauth.client_secret}}&grant_type=refresh_token&refresh_token={{oauth.refresh_token}}