Reference
Pipedrive
Set up Pipedrive OAuth for sales CRM and pipeline management
Overview
Section titled “Overview”Connect your users to Pipedrive for sales pipeline management, contact tracking, deal management, and activity logging.
| Property | Value |
|---|---|
| Provider ID | pipedrive |
| Category | CRM |
| PKCE | Supported |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
Step 1: Create a Pipedrive OAuth App
Section titled “Step 1: Create a Pipedrive OAuth App”Go to the Pipedrive Developer Hub
Navigate to developers.pipedrive.com and sign in.
Create a new app
Go to Your Apps and click Create an app. Fill in the app name and details.
Configure the redirect URI
Under OAuth & Access scopes, add the Alter callback URL from the Developer Portal to the Callback URL field.
Get credentials
Copy the Client ID and Client Secret.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”Open the Developer Portal
Go to portal.alterauth.com and navigate to the application.
Add Pipedrive provider
Go to OAuth Providers > Add Provider > Pipedrive.
Enter credentials
- Client ID: Paste your Pipedrive Client ID
- Client Secret: Paste your Pipedrive Client Secret
Select scopes
Choose the scopes the application needs.
Save
Click Save. The provider is now active.
Available Scopes
Section titled “Available Scopes”| Scope | Description |
|---|---|
deals:read | Read deal records |
deals:write | Create, update, and delete deals |
contacts:read | Read contact records |
contacts:write | Create, update, and delete contacts |
activities:read | Read activity records |
activities:write | Create, update, and delete activities |
Additional scopes
Section titled “Additional scopes”| Scope | Description |
|---|---|
activities:full | Full read and write access to activities |
admin | Administer company-wide settings and data |
contact-fields:full | Full read and write access to person and organization fields |
contacts:full | Full read and write access to persons and organizations |
deal-fields:full | Full read and write access to deal fields |
deals:full | Full read and write access to deals, their products, and followers |
leads:full | Full read and write access to leads |
product-fields:full | Full read and write access to product fields |
products:full | Full read and write access to products |
project-fields:full | Full read and write access to project fields |
projects:full | Full read and write access to projects |
search:read | Search across the account’s deals, persons, organizations, and products |
- See the Pipedrive OAuth authorization documentation for more details.
Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path |
|---|---|---|---|
addLead | write | POST | /leads |
getLead | read | GET | /leads/{id} |
getLeads | read | GET | /leads |
updateLead | write | PATCH | /leads/{id} |
deleteLead | delete | DELETE | /leads/{id} |
searchLeads | read | GET | /leads/search |
addNote | write | POST | /notes |
getNote | read | GET | /notes/{id} |
getNotes | read | GET | /notes |
updateNote | write | PUT | /notes/{id} |
deleteNote | delete | DELETE | /notes/{id} |
addTask | write | POST | /tasks |
getTask | read | GET | /tasks/{id} |
updateTask | write | PUT | /tasks/{id} |
deleteTask | delete | DELETE | /tasks/{id} |
addProject | write | POST | /projects |
getProject | read | GET | /projects/{id} |
getProjects | read | GET | /projects |
updateProject | write | PUT | /projects/{id} |
deleteProject | delete | DELETE | /projects/{id} |
mergeDeals | write | PUT | /deals/{id}/merge |
mergePersons | write | PUT | /persons/{id}/merge |
getMailThreads | read | GET | /mailbox/mailThreads |
getMailThread | read | GET | /mailbox/mailThreads/{id} |
deleteMailThread | delete | DELETE | /mailbox/mailThreads/{id} |
getCurrentUser | read | GET | /users/me |
getUsers | read | GET | /users |
addUser | admin | POST | /users |
updateUser | admin | PUT | /users/{id} |