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
- Create a [Pipedrive](https://pipedrive.com/){:target=_blank .external-link} account.
19
-
- For OAuth2 authentication, create a [Pipedrive developer sandbox](https://developers.pipedrive.com/){:target=_blank .external-link} account.
20
-
21
16
## Supported authentication methods
22
17
23
18
- API token
@@ -29,19 +24,91 @@ Refer to [Pipedrive's developer documentation](https://pipedrive.readme.io/docs/
29
24
30
25
## Using API token
31
26
32
-
To configure this credential, you'll need:
27
+
To configure this credential, you'll need a [Pipedrive](https://pipedrive.com/){:target=_blank .external-link} account and:
28
+
29
+
- An **API Token**
30
+
31
+
To get your API token:
32
+
33
+
1. Open your [**API Personal Preferences**](https://app.pipedrive.com/settings/api){:target=_blank .external-link}.
34
+
2. Copy **Your personal API token** and enter it in your n8n credential.
33
35
34
-
- An **API Token**: To get your API token, select your account name in the upper right > **Company Settings > Personal Preferences > API**. Refer to [How to find the API token](https://pipedrive.readme.io/docs/how-to-find-the-api-token){:target=_blank .external-link} for more information.
36
+
If you have multiple companies, you'll need to select the correct company first:
37
+
38
+
1. Select your account name and be sure you're viewing the correct company.
39
+
2. Then select **Company Settings**.
40
+
2. Select **Personal Preferences**.
41
+
3. Select the **API** tab.
42
+
4. Copy **Your personal API token** and enter it in your n8n credential.
43
+
44
+
Refer to [How to find the API token](https://pipedrive.readme.io/docs/how-to-find-the-api-token){:target=_blank .external-link} for more information.
35
45
36
46
## Using OAuth2
37
47
38
-
To configure this credential, you'll need:
48
+
To configure this credential, you'll need a [Pipedrive developer sandbox account](https://developers.pipedrive.com/){:target=_blank .external-link} and:
49
+
50
+
- A **Client ID**
51
+
- A **Client Secret**
52
+
53
+
To get both, you'll need to register a new app:
54
+
55
+
1. Select your profile name in the upper right corner.
56
+
2. Find the company name of your sandbox account and select **Developer Hub**.
57
+
58
+
/// note | No Developer Hub
59
+
If you don't see **Developer Hub** in your account dropdown, sign up for a [developer sandbox account](https://developers.pipedrive.com/){:target=_blank .external-link}.
60
+
///
61
+
62
+
3. Select **Create an app**.
63
+
4. Select **Create public app**. The app's **Basic info** tab opens.
64
+
5. Enter an **App name** for your app, like `n8n integration`.
65
+
6. Copy the **OAuth Redirect URL** from n8n and add it as the app's **Callback URL**.
8. Turn on appropriate **Scopes** for your app. Refer to [Pipedrive node scopes](#pipedrive-node-scopes) and [Pipedrive Trigger node scopes](#pipedrive-trigger-node-scopes) below for more guidance.
68
+
8. Copy the **Client ID** and enter it in your n8n credential.
69
+
9. Copy the **Client Secret** and enter it in your n8n credential.
70
+
71
+
Refer to [Registering a public app](https://pipedrive.readme.io/docs/marketplace-registering-the-app){:target=_blank .external-link} for more information.
72
+
73
+
### Pipedrive node scopes
74
+
75
+
The scopes you add to your app depend on which node(s) you want to use it for in n8n and what actions you want to complete with those.
76
+
77
+
Scopes you may need for the [Pipedrive](/integrations/builtin/app-nodes/n8n-nodes-base.pipedrive/) node:
| Activity | Get data of an activity <br> Get data of all activities |**Activities: Read only** or <br> **Activities: Full Access**|`activities:read` or <br> `activities:full`|
| Deal | Get data of a deal <br> Get data of all deals <br> Search a deal |**Deals: Read only** or <br> **Deals: Full Access**|`deals:read` or <br> `deals:full`|
| Deal Activity | Get all activities of a deal |**Activities: Read only** or <br> **Activities: Full Access**|`activities:read` or <br> `activities:full`|
86
+
| Deal Product | Get all products in a deal |**Products: Read Only** or <br> **Products: Full Access**|`products:read` or <br> `products:full`|
87
+
| File | Download <br> Get data of a file | Refer to note below | Refer to note below |
88
+
| File | Create <br> Delete | Refer to note below | Refer to note below |
89
+
| Lead | Get data of a lead <br> Get data of all leads |**Leads: Read only** or <br> **Leads: Full access**|`leads:read` or <br> `leads:full`|
90
+
| Lead | Create <br> Delete <br> Update |**Leads: Full access**|`leads:full`|
91
+
| Note | Get data of a note <br> Get data of all notes | Refer to note below | Refer to note below |
92
+
| Note | Create <br> Delete <br> Update | Refer to note below | Refer to note below |
93
+
| Organization | Get data of an organization <br> Get data of all organizations <br> Search |**Contacts: Read Only** or <br> **Contacts: Full Access**|`contacts:read` or <br> `contacts:full`|
| Person | Get data of a person <br> Get data of all persons <br> Search |**Contacts: Read Only** or <br> **Contacts: Full Access**|`contacts:read` or <br> `contacts:full`|
96
+
| Person | Create <br> Delete <br> Update |**Contacts: Full Access**|`contacts:full`|
97
+
| Product | Get data of all products |**Products: Read Only**|`products:read`|
98
+
99
+
/// note | Files and Notes
100
+
The scopes for Files and Notes depend on which object they relate to:
101
+
102
+
- Files relate to Deals, Activities, or Contacts.
103
+
- Notes relate to Deals or Contacts.
104
+
105
+
Refer to those objects' scopes.
106
+
///
39
107
40
-
- A **Client ID**: Created when you register a new app.
41
-
- A **Client Secret**: Created when you register a new app.
108
+
The Pipedrive node also supports Custom API calls. Add relevant scopes for whatever custom API calls you intend to make.
42
109
43
-
To get both, open the **Developer Hub** in your account and [register a new public app](https://pipedrive.readme.io/docs/marketplace-registering-the-app#register-a-new-public-app){:target=_blank .external-link}. Copy the **OAuth Redirect URL** from n8n and add it as the app's **Callback URL**. Copy the **Client ID** and **Client Secret** from the app's **OAuth & access scopes** tab and add them to your n8n credential.
110
+
Refer to [Scopes and permissions explanations](https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations){:target=_blank .external-link} for more information.
44
111
45
-
Be sure to add appropriate [scopes](https://pipedrive.readme.io/docs/marketplace-registering-the-app#oauth--access-scopes){:target=_blank .external-link} to your app.
112
+
### Pipedrive Trigger node scopes
46
113
47
-
Refer to [App registration form](https://pipedrive.readme.io/docs/marketplace-registering-the-app#app-registration-form){:target=_blank .external-link} for more information on registering your app. Refer to [Scopes and permissions explanations](https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations){:target=_blank .external-link} for more information on app scopes.
114
+
The [Pipedrive Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.pipedrivetrigger/) node requires the **Webhooks: Full access** (`webhooks:full`) scope.
0 commit comments