Pipedrive

Pipedrive module for RobinPath.

Package: @robinpath/pipedrive | Category: Crm | Type: Integration

Authentication

pipedrive.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the pipedrive module when you need to:

• listDeals -- Use pipedrive.listDeals to perform this operation
• getDeal -- Use pipedrive.getDeal to perform this operation
• createDeal -- Use pipedrive.createDeal to perform this operation
• updateDeal -- Use pipedrive.updateDeal to perform this operation
• deleteDeal -- Use pipedrive.deleteDeal to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure pipedrive credentials.	object
listDeals	listDeals	object
getDeal	getDeal	object
createDeal	createDeal	object
updateDeal	updateDeal	object
deleteDeal	deleteDeal	object
listPersons	listPersons	object
getPerson	getPerson	object
createPerson	createPerson	object
updatePerson	updatePerson	object
deletePerson	deletePerson	object
listOrganizations	listOrganizations	object
getOrganization	getOrganization	object
createOrganization	createOrganization	object
updateOrganization	updateOrganization	object
listActivities	listActivities	object
createActivity	createActivity	object
updateActivity	updateActivity	object
listPipelines	listPipelines	object
listStages	listStages	object
searchDeals	searchDeals	object

Functions

setCredentials

Configure pipedrive credentials.

Module: pipedrive | Returns: object -- API response.

pipedrive.setCredentials

Parameter	Type	Required	Description
apiToken	string	Yes	apiToken

---

listDeals

listDeals

Module: pipedrive | Returns: object -- API response.

pipedrive.listDeals

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getDeal

getDeal

Module: pipedrive | Returns: object -- API response.

pipedrive.getDeal

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createDeal

createDeal

Module: pipedrive | Returns: object -- API response.

pipedrive.createDeal

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateDeal

updateDeal

Module: pipedrive | Returns: object -- API response.

pipedrive.updateDeal

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteDeal

deleteDeal

Module: pipedrive | Returns: object -- API response.

pipedrive.deleteDeal

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPersons

listPersons

Module: pipedrive | Returns: object -- API response.

pipedrive.listPersons

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getPerson

getPerson

Module: pipedrive | Returns: object -- API response.

pipedrive.getPerson

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createPerson

createPerson

Module: pipedrive | Returns: object -- API response.

pipedrive.createPerson

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updatePerson

updatePerson

Module: pipedrive | Returns: object -- API response.

pipedrive.updatePerson

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deletePerson

deletePerson

Module: pipedrive | Returns: object -- API response.

pipedrive.deletePerson

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listOrganizations

listOrganizations

Module: pipedrive | Returns: object -- API response.

pipedrive.listOrganizations

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getOrganization

getOrganization

Module: pipedrive | Returns: object -- API response.

pipedrive.getOrganization

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createOrganization

createOrganization

Module: pipedrive | Returns: object -- API response.

pipedrive.createOrganization

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateOrganization

updateOrganization

Module: pipedrive | Returns: object -- API response.

pipedrive.updateOrganization

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listActivities

listActivities

Module: pipedrive | Returns: object -- API response.

pipedrive.listActivities

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createActivity

createActivity

Module: pipedrive | Returns: object -- API response.

pipedrive.createActivity

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateActivity

updateActivity

Module: pipedrive | Returns: object -- API response.

pipedrive.updateActivity

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listPipelines

listPipelines

Module: pipedrive | Returns: object -- API response.

pipedrive.listPipelines

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listStages

listStages

Module: pipedrive | Returns: object -- API response.

pipedrive.listStages

Parameter	Type	Required	Description
input	string	No	Input parameter

---

searchDeals

searchDeals

Module: pipedrive | Returns: object -- API response.

pipedrive.searchDeals

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Pipedrive API error (${res.status}): ${t}	Check the error message for details
pipedrive.setCredentials requires apiToken.	Check the error message for details
pipedrive.updateDeal requires an ID.	Check the error message for details
pipedrive.deleteDeal requires an ID.	Check the error message for details
pipedrive.updatePerson requires an ID.	Check the error message for details
pipedrive.deletePerson requires an ID.	Check the error message for details
pipedrive.updateOrganization requires an ID.	Check the error message for details
pipedrive.updateActivity requires an ID.	Check the error message for details

@desc "List deals and validate result"
do
  set $result as pipedrive.listDeals
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Deals

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  pipedrive.setCredentials $token
enddo

@desc "List deals and iterate results"
do
  set $result as pipedrive.listDeals
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createDeal

Create a new resource and capture the result.

@desc "Setup authentication"
do
  pipedrive.setCredentials $token
enddo

@desc "Create deal"
do
  set $result as pipedrive.createDeal
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  pipedrive.setCredentials $token
enddo

@desc "Create deal and update deal"
do
  set $created as pipedrive.createDeal
  # Update the created item
  pipedrive.updateDeal
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  pipedrive.setCredentials $token
enddo

@desc "List deals and create deal"
do
  set $existing as pipedrive.listDeals
  if $existing == null
    pipedrive.createDeal
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Pipedrive workflow

Chain multiple pipedrive operations together.

@desc "Setup authentication"
do
  pipedrive.setCredentials $token
enddo

@desc "List deals, get deal, and more"
do
  set $r_listDeals as pipedrive.listDeals
  set $r_getDeal as pipedrive.getDeal
  set $r_createDeal as pipedrive.createDeal
  print "All operations complete"
enddo

6. Safe listDeals with validation

Check results before proceeding.

@desc "Setup authentication"
do
  pipedrive.setCredentials $token
enddo

@desc "List deals and validate result"
do
  set $result as pipedrive.listDeals
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• hubspot -- HubSpot module for complementary functionality
• salesforce -- Salesforce module for complementary functionality
• freshdesk -- Freshdesk module for complementary functionality
• intercom -- Intercom module for complementary functionality
• zoho -- Zoho module for complementary functionality