Pipedrive actions
Pipedrive actions are actions for interacting with the Pipedrive API.
All Pipedrive actions must use the pipedrive connection instance, created by one of the actions pipedrive.create or pipedrive.create_with_api_token.
Connection options
There are two options to generate a pipedrive connection instance, let's go into more detail on how to do it and the necessary actions for each one:
Instantiation with Client
pipedrive.create
Creates Pipedrive connection via Client.
After this command, another 3 will be needed: pipedrive.authorization_url, pipedrive.exchange_code and pipedrive.set_access_token.
Parameters:
client_id - ID provided when you register at Pipedrive Marketplace.
client_secret - password provided when you register at Pipedrive Marketplace.
Return:
pipedrive - pipedrive connection that will be passed as parameter when calling other actions.
pipedrive.authorization_url
Generates the authorization url.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
redirect_url - url provided when you register at Pipedrive Marketplace.
Return:
url - authorization url.
pipedrive.exchange_code
Generates the Authorization Token.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
redirect_url - url provided when you register at Pipedrive Marketplace.
code - code provided when you register at Pipedrive Marketplace.
Return:
token - authorization token.
pipedrive.set_access_token
Sets your authentication token for future pipedrive connections.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
access_token - authentication token provided by pipedrive.exchange_code.
Return:
This action has no return.
pipedrive.refresh_token
Resets the duration of the Authorization Token.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
refresh_token - authentication token
Return:
token - authorization token.
Instantiation with Token API
pipedrive.create_with_api_token
Creates Pipedrive connection via Token API.
Parameters:
domain - domain url of your pipedrive account.
api_token - API token of the company you want to make the pipedrive connection.
Return:
pipedrive - pipedrive connection that will be passed as parameter when calling other actions.
Actions
pipedrive.get_all_activities
Returns all activities.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
Return:
response - activities found.
pipedrive.get_all_persons
Returns all persons.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
Return:
response - persons found.
pipedrive.get_all_organizations
Returns all organizations.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
Return:
response - organizations found.
pipedrive.create_person
Create a new person.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
data - information needed to create a new person.
Return:
response - returns the status of the action.
pipedrive.create_deal
Create a new deal.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
data - information needed to create a new deal.
Return:
response - returns the status of the action.
pipedrive.create_activity
Create a new activity.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
data - information needed to create a new activity.
Return:
response - returns the status of the action.
pipedrive.search_persons
Searches for all people that match the params.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
params - information needed to locate the people.
Return:
response - people found.
pipedrive.search_organizations
Search for all organizations that match the params.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
params - information needed to locate the organizations.
Return:
response - organizations found.
pipedrive.get_person_deals
List the deals related to a certain person, which fit the params.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
person_id - id of the person to be searched for.
params - information needed to locate the deals.
Return:
response - deals found.
pipedrive.get_person_activities
Lists all activities related to a certain person.
Parameters:
pipedrive - pipedrive instance provided by pipedrive.create.
person_id - id of the person to be searched for.
Return:
response - activities found.