You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/gmail/sources/new-email-received/README.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
##Overview
1
+
# Overview
2
2
3
3
The Gmail - New Email Received (Instant) source enables you to trigger Pipedream workflows based on real-time changes to your Gmail inbox.
4
4
5
-
##Getting Started
5
+
# Getting Started
6
6
7
-
###Prerequisites
7
+
## Prerequisites
8
8
9
9
- A Google Cloud account
10
10
- A Pipedream account on the Advanced plan or higher
11
11
- Basic familiarity with Google Cloud Console
12
12
13
-
###Quickstart
13
+
## Quickstart
14
14
15
15
1. Create a custom Gmail client in Google Cloud Console
16
16
2. Enable Gmail API and Pub/Sub API
@@ -20,9 +20,9 @@ The Gmail - New Email Received (Instant) source enables you to trigger Pipedream
20
20
21
21
For detailed instructions, follow the steps below.
22
22
23
-
###Detailed Setup Instructions
23
+
## Detailed Setup Instructions
24
24
25
-
####1. Create a Gmail app
25
+
### 1. Create a Gmail app
26
26
27
27
1. Sign in to the [Google Cloud Console](https://console.cloud.google.com/welcome)
28
28
2. Select an existing project, or create a new one
@@ -46,13 +46,14 @@ For detailed instructions, follow the steps below.
46
46
47
47
> **Note:** If you encounter issues with API enablement, ensure you have the necessary permissions in your Google Cloud project.
48
48
49
-
####2. Set up the OAuth consent screen
49
+
### 2. Set up the OAuth consent screen
50
50
51
51
1. Click **OAuth consent screen** on the left side
52
52
53
53

54
54
55
55
2. Set up the OAuth consent screen:
56
+
56
57
- Select User Type (Internal for Google Workspace users, External for others)
@@ -61,7 +62,7 @@ For detailed instructions, follow the steps below.
61
62
62
63

63
64
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
65
66
66
67
1. Navigate to the **Credentials** section on the left side.
67
68
@@ -83,8 +84,8 @@ For detailed instructions, follow the steps below.
83
84

84
85
85
86
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.
88
89
9. On your Google Cloud app configuration page, click **Add URI** and paste the Redirect URI from the previous step.
89
90
90
91

@@ -99,7 +100,7 @@ For detailed instructions, follow the steps below.
99
100
100
101
> **Important:** When creating the OAuth client ID, make sure to copy the Redirect URI from Pipedream exactly as shown to avoid authentication errors.
101
102
102
-
####4. Create service account
103
+
### 4. Create service account
103
104
104
105
1. Navigate to **[Credentials](https://console.cloud.google.com/apis/credentials?)** under APIs & Services, and click **Create Credentials** > **Service Account**.
105
106
@@ -113,12 +114,12 @@ For detailed instructions, follow the steps below.
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.
119
120
2. While configuring the New Email Received trigger, you should be prompted to input your Service Account Key JSON.
120
121
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)
122
123
123
124
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.
124
125
@@ -131,7 +132,7 @@ Google has a [7 day expiration window](https://developers.google.com/identity/pr
131
132
132
133

133
134
134
-
##Troubleshooting
135
+
# Troubleshooting
135
136
136
137
-**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.
137
138
-**API Not Enabled**: Ensure both Gmail API and Pub/Sub API are enabled in your Google Cloud project.
0 commit comments