Skip to content

Commit 97b8755

Browse files
Update README.md
1 parent 87a0502 commit 97b8755

File tree

1 file changed

+15
-14
lines changed
  • components/gmail/sources/new-email-received

1 file changed

+15
-14
lines changed

components/gmail/sources/new-email-received/README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
## Overview
1+
# Overview
22

33
The Gmail - New Email Received (Instant) source enables you to trigger Pipedream workflows based on real-time changes to your Gmail inbox.
44

5-
## Getting Started
5+
# Getting Started
66

7-
### Prerequisites
7+
## Prerequisites
88

99
- A Google Cloud account
1010
- A Pipedream account on the Advanced plan or higher
1111
- Basic familiarity with Google Cloud Console
1212

13-
### Quickstart
13+
## Quickstart
1414

1515
1. Create a custom Gmail client in Google Cloud Console
1616
2. Enable Gmail API and Pub/Sub API
@@ -20,9 +20,9 @@ The Gmail - New Email Received (Instant) source enables you to trigger Pipedream
2020

2121
For detailed instructions, follow the steps below.
2222

23-
### Detailed Setup Instructions
23+
## Detailed Setup Instructions
2424

25-
#### 1. Create a Gmail app
25+
### 1. Create a Gmail app
2626

2727
1. Sign in to the [Google Cloud Console](https://console.cloud.google.com/welcome)
2828
2. Select an existing project, or create a new one
@@ -46,13 +46,14 @@ For detailed instructions, follow the steps below.
4646

4747
> **Note:** If you encounter issues with API enablement, ensure you have the necessary permissions in your Google Cloud project.
4848
49-
#### 2. Set up the OAuth consent screen
49+
### 2. Set up the OAuth consent screen
5050

5151
1. Click **OAuth consent screen** on the left side
5252

5353
![Click "OAuth consent screen" in the left navigation menu](https://res.cloudinary.com/pipedreamin/image/upload/v1663268506/docs/components/CleanShot_2022-09-15_at_15.01.24_wravfb.png)
5454

5555
2. Set up the OAuth consent screen:
56+
5657
- Select User Type (Internal for Google Workspace users, External for others)
5758
- Fill in required fields
5859
- Add scopes: `email`, `profile`, `https://www.googleapis.com/auth/gmail.modify`, `https://www.googleapis.com/auth/gmail.settings.basic`
@@ -61,7 +62,7 @@ For detailed instructions, follow the steps below.
6162

6263
![Select "External" in the OAuth Consent Screen](https://res.cloudinary.com/pipedreamin/image/upload/v1663268545/docs/components/CleanShot_2022-09-15_at_15.02.22_fiekq1.png)
6364

64-
#### 3. Create OAuth Credentials in Google and Custom OAuth Client in Pipedream
65+
### 3. Create OAuth Credentials in Google and Custom OAuth Client in Pipedream
6566

6667
1. Navigate to the **Credentials** section on the left side.
6768

@@ -83,8 +84,8 @@ For detailed instructions, follow the steps below.
8384
![Custom OAuth Client creation on Pipedream](https://res.cloudinary.com/dpenc2lit/image/upload/v1724882777/Screenshot_2024-08-28_at_2.53.15_PM_rxtusm.png)
8485

8586
6. Click **New OAuth Client**, and search for Gmail.
86-
7. Name your OAuth Client, and click **Continue**.
87-
8. Copy the **Redirect URI**, and return to your previous window.
87+
7. Name your OAuth Client, and click **Continue**.
88+
8. Copy the **Redirect URI**, and return to your previous window.
8889
9. On your Google Cloud app configuration page, click **Add URI** and paste the Redirect URI from the previous step.
8990

9091
![Add the Pipedream URL to the Callback Redirect URL option](https://res.cloudinary.com/pipedreamin/image/upload/v1663270187/docs/components/CleanShot_2022-09-15_at_15.16.10_hvbocb.png)
@@ -99,7 +100,7 @@ For detailed instructions, follow the steps below.
99100

100101
> **Important:** When creating the OAuth client ID, make sure to copy the Redirect URI from Pipedream exactly as shown to avoid authentication errors.
101102
102-
#### 4. Create service account
103+
### 4. Create service account
103104

104105
1. Navigate to **[Credentials](https://console.cloud.google.com/apis/credentials?)** under APIs & Services, and click **Create Credentials** > **Service Account**.
105106

@@ -113,12 +114,12 @@ For detailed instructions, follow the steps below.
113114

114115
![Create private key](https://res.cloudinary.com/dpenc2lit/image/upload/v1724964634/Screenshot_2024-08-29_at_1.47.34_PM_tmalc7.png)
115116

116-
#### 5. Connect your Gmail account in Pipedream
117+
### 5. Connect your Gmail account in Pipedream
117118

118119
1. From the Pipedream Accounts page, click **OAuth Clients**. Next to your newly created Gmail client, click the three-dot menu on the righthand side and click **Connect Account**. Or you can also connect your account from the workflow builder, when configuring the Gmail trigger.
119120
2. While configuring the New Email Received trigger, you should be prompted to input your Service Account Key JSON.
120121

121-
#### 6. Publish your custom Gmail app (required for External app type only)
122+
### 6. Publish your custom Gmail app (required for External app type only)
122123

123124
Google has a [7 day expiration window](https://developers.google.com/identity/protocols/oauth2#:~:text=A%20Google%20Cloud,Connect%20equivalents) on refresh tokens for **External** applications with a publishing status of "Testing", so you will need to **Publish** your application in order to maintain your account connection.
124125

@@ -131,7 +132,7 @@ Google has a [7 day expiration window](https://developers.google.com/identity/pr
131132

132133
![Confirmation of changes](https://res.cloudinary.com/dpenc2lit/image/upload/v1698166716/Screenshot_2023-10-24_at_9.50.18_AM_mndtyc.png)
133134

134-
## Troubleshooting
135+
# Troubleshooting
135136

136137
- **Authentication Failed**: Double-check that your Redirect URI is correct and that you've added your email as a test user in the OAuth consent screen.
137138
- **API Not Enabled**: Ensure both Gmail API and Pub/Sub API are enabled in your Google Cloud project.

0 commit comments

Comments
 (0)