Pipedrive

Create deals, manage contacts, and track activities in Pipedrive.

CRM and salesOAuth30 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (30)
create-deal
create-person
find-deal
add-follower
add-labels-to-person
add-product-to-deal
attach-file
create-activity
create-lead
create-note
create-organization
create-product
custom_api_call
find-activity
find-deals-associated-with-person
find-lead
find-notes
find-organization
find-person
find-product
find-products
find-user
get-note
get-product
update-activity
update-deal
update-lead
update-organization
update-person
update-product
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("pipedrive", "create-deal", {
    "title": "<title>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Pipedrive answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "pipedrive-create-deal",
  name: "Pipedrive: Create Deal",
  description: "Calls Pipedrive when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("pipedrive", {
      "action": "create-deal",
      "title": "<title>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/pipedrive/create-deal" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"title":"<title>"}}'

Actions

create-dealin catalog

Create Deal. Creates a new deal.

Also accepted as create_deal.

Input	Type	Description
`title`required	text	Title
`creationTime`optional	date-time (ISO)	Creation Time
`status`optional	one of "open" \| "won" \| "lost" \| "deleted"	Status
`stageId`optional	id (picked from your account)	If a stage is chosen above, the pipeline field will be ignored.
`pipelineId`optional	id (picked from your account)	Pipeline
`ownerId`optional	id (picked from your account)	Owner
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`personId`optional	number	You can use Find Person action to retrieve person ID.
`labelIds`optional	ids (picked from your account)	Label
`probability`optional	number	Probability
`expectedCloseDate`optional	date-time (ISO)	Please enter date in YYYY-MM-DD format.
`dealValue`optional	number	Value
`dealValueCurrency`optional	text	Please enter currency code (e.g., "USD", "EUR").
`visibleTo`optional	one of "1" \| "3"	Visible To
`customfields`optional	object (depends on other props)	Custom Fields

create-personin catalog

Create Person. Creates a new person.

Also accepted as create_person.

Input	Type	Description
`name`optional	text	Name
`ownerId`optional	id (picked from your account)	Owner
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`email`optional	array	Email
`phone`optional	array	Phone
`labelIds`optional	ids (picked from your account)	Label
`firstName`optional	text	First Name
`lastName`optional	text	Last Name
`visibleTo`optional	one of "1" \| "3"	Visible To
`marketing_status`optional	one of "no_consent" \| "unsubscribed" \| "subscribed" \| "archived"	Marketing opt-in status
`customfields`optional	object (depends on other props)	Custom Fields

find-dealin catalog

Find Deal. Finds a deal by any field.

Input	Type	Description
`searchField`required	id (picked from your account)	Field to search by
`searchFieldValue`required	object (depends on other props)	Field Value

add-follower

Add Follower. Adds a follower to a deal, person, organization or product.

Input	Type	Description
`followerId`required	id (picked from your account)	Follower
`entity`required	one of "deal" \| "person" \| "organization" \| "product"	Type of object to add the follower to.
`entityId`required	text	ID of the object to add the follower to.

add-labels-to-person

Add Labels to Person. Adds existing labels to an existing person.

Input	Type	Description
`personId`required	number	You can use Find Person action to retrieve person ID.
`labelIds`required	ids (picked from your account)	Label

add-product-to-deal

Add Product to Deal. Adds a product to a deal.

Input	Type	Description
`dealId`required	number	You can use Find Deal action to retrieve deal ID.
`productId`required	number	You can use Find Product action to retrieve product ID.
`price`required	number	Price
`quantity`required	number	Quantity
`discount`optional	number	Discount
`discountType`optional	one of "percentage" \| "amount"	Discount Type
`comments`optional	long text	Comments
`enableProduct`optional	boolean	Enable Product?
`taxMethod`optional	one of "exclusive" \| "inclusive" \| "none"	Tax Method
`taxPercentage`optional	number	Tax Percentage

attach-file

Attach File. Uploads a file and attaches it to a deal,person,organization,activity or product.

Input	Type	Description
`file`required	file	File
`fileName`required	text	File Name
`dealId`optional	number	You can use Find Deal action to retrieve deal ID.
`personId`optional	number	You can use Find Person action to retrieve person ID.
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`productId`optional	number	You can use Find Product action to retrieve product ID.
`activityId`optional	number	Activity ID

create-activity

Create Activity. Creates a new activity.

Input	Type	Description
`subject`required	text	Subject
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`personId`optional	number	You can use Find Person action to retrieve person ID.
`dealId`optional	number	You can use Find Deal action to retrieve deal ID.
`leadId`optional	text	Lead ID
`assignTo`optional	id (picked from your account)	Assign To
`type`optional	id (picked from your account)	Activity Type
`dueDate`optional	date-time (ISO)	Please enter date in YYYY-MM-DD format.
`dueTime`optional	text	Please enter time in HH:MM format.
`duration`optional	text	Please enter time in HH:MM format (e.g., "01:30" for 1 hour 30 minutes).
`isDone`optional	boolean	Mark as Done?
`busy`optional	one of "free" \| "busy"	Free or Busy
`note`optional	long text	Note
`publicDescription`optional	long text	Public Description

create-lead

Create Lead. Creates a new lead.

Input	Type	Description
`title`required	text	Title
`ownerId`optional	id (picked from your account)	Owner
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`personId`optional	number	You can use Find Person action to retrieve person ID.
`labelIds`optional	ids (picked from your account)	Label
`expectedCloseDate`optional	date-time (ISO)	Please enter date in YYYY-MM-DD format.
`visibleTo`optional	one of "1" \| "3"	Visible To
`channel`optional	id (picked from your account)	Channel
`leadValue`optional	number	Lead Value Amount
`leadValueCurrency`optional	text	The currency of the lead value (e.g., "USD", "EUR").
`customfields`optional	object (depends on other props)	Custom Fields

create-note

Create Note. Creates a new note.

Input	Type	Description
`content`required	long text	Content
`dealId`optional	number	You can use Find Deal action to retrieve deal ID.
`pinnedToDeal`optional	boolean	Pin note to deal?
`personId`optional	number	You can use Find Person action to retrieve person ID.
`pinnedToPerson`optional	boolean	Pin note to person?
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`pinnedToOrganization`optional	boolean	Pin note to organization?
`leadId`optional	text	Lead ID
`pinnedToLead`optional	boolean	Pin note to lead?

create-organization

Create Organization. Creates a new organization.

Input	Type	Description
`name`required	text	Name
`ownerId`optional	id (picked from your account)	Owner
`visibleTo`optional	one of "1" \| "3"	Visible To
`labelIds`optional	ids (picked from your account)	Label
`address`optional	long text	Address
`customfields`optional	object (depends on other props)	Custom Fields

create-product

Create Product. Creates a new product.

Input	Type	Description
`name`required	text	Name
`code`optional	text	Code
`description`optional	long text	Description
`unit`optional	text	Unit
`tax`optional	number	Tax percentage
`isActive`optional	boolean	Is Active ?
`ownerId`optional	id (picked from your account)	Owner
`currency`optional	text	Please enter currency code (e.g., "USD", "EUR").
`price`optional	number	Price
`cost`optional	number	Cost
`overheadCost`optional	number	Overhead Cost
`visibleTo`optional	one of "1" \| "3"	Visible To
`customfields`optional	object (depends on other props)	Custom Fields

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

find-activity

Find Activity. Finds an activity by subject.

Input	Type	Description
`subject`required	text	Subject
`exactMatch`optional	boolean	Exact Match
`assignTo`optional	id (picked from your account)	Assign To
`type`optional	id (picked from your account)	Activity Type
`filterId`optional	id (picked from your account)	Filter
`status`optional	one of "1" \| "0"	Status

find-deals-associated-with-person

Find Deals Associated With Person. Finds multiple deals related to a specific person.

Input	Type	Description
`personId`required	number	You can use Find Person action to retrieve person ID.

find-lead

Find Lead. Finds leads by title.

Input	Type	Description
`term`required	text	The title to search for.
`exact_match`optional	boolean	When enabled, only full exact matches against the given title are returned. It is not case sensitive.

find-notes

Find Notes. Finds notes by Deal, Lead, Person, or Organization ID.

Input	Type	Description
`objectType`required	one of "deal_id" \| "lead_id" \| "person_id" \| "org_id"	Search By
`objectId`required	text	ID

find-organization

Find Organization. Finds an organization.

Input	Type	Description
`searchField`required	id (picked from your account)	Field to search by
`searchFieldValue`required	object (depends on other props)	Field Value

find-person

Find Person. Finds a person.

Input	Type	Description
`searchField`required	id (picked from your account)	Field to search by
`searchFieldValue`required	object (depends on other props)	Field Value

find-product

Find Product. Finds a product by name

Input	Type	Description
`searchTerm`required	text	Search Term

find-products

Find Products. Finds a product or products by name or product code.

Input	Type	Description
`field`required	one of "name" \| "code"	Field to search by
`fieldValue`required	text	Field Value

find-user

Find User. Finds a user by name or email.

Input	Type	Description
`field`required	one of "name" \| "email"	Field to search by
`fieldValue`required	text	Field Value

get-note

Retrieve a Note. Finds a note by ID.

Input	Type	Description
`noteId`required	number	Note ID

get-product

Retrieve a Product. Finds a product by ID.

Input	Type	Description
`productId`required	number	Product ID

update-activity

Update Activity. Updates an existing activity.

Input	Type	Description
`activityId`required	number	Activity ID
`subject`optional	text	Subject
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`personId`optional	number	You can use Find Person action to retrieve person ID.
`dealId`optional	number	You can use Find Deal action to retrieve deal ID.
`leadId`optional	text	Lead ID
`assignTo`optional	id (picked from your account)	Assign To
`type`optional	id (picked from your account)	Activity Type
`dueDate`optional	date-time (ISO)	Please enter date in YYYY-MM-DD format.
`dueTime`optional	text	Please enter time in HH:MM format.
`duration`optional	text	Please enter time in HH:MM format (e.g., "01:30" for 1 hour 30 minutes).
`isDone`optional	boolean	Mark as Done?
`busy`optional	one of "free" \| "busy"	Free or Busy
`note`optional	long text	Note
`publicDescription`optional	long text	Public Description

update-deal

Update Deal. Updates an existing deal.

Input	Type	Description
`dealId`required	number	You can use Find Deal action to retrieve deal ID.
`title`optional	text	Title
`creationTime`optional	date-time (ISO)	Creation Time
`status`optional	one of "open" \| "won" \| "lost" \| "deleted"	Status
`stageId`optional	id (picked from your account)	If a stage is chosen above, the pipeline field will be ignored.
`pipelineId`optional	id (picked from your account)	Pipeline
`ownerId`optional	id (picked from your account)	Owner
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`personId`optional	number	You can use Find Person action to retrieve person ID.
`labelIds`optional	ids (picked from your account)	Label
`probability`optional	number	Probability
`expectedCloseDate`optional	date-time (ISO)	Please enter date in YYYY-MM-DD format.
`dealValue`optional	number	Value
`dealValueCurrency`optional	text	Please enter currency code (e.g., "USD", "EUR").
`visibleTo`optional	one of "1" \| "3"	Visible To
`customfields`optional	object (depends on other props)	Custom Fields

update-lead

Update Lead. Updates an existing lead.

Input	Type	Description
`leadId`required	text	Lead ID
`title`optional	text	Title
`ownerId`optional	id (picked from your account)	Owner
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`personId`optional	number	You can use Find Person action to retrieve person ID.
`labelIds`optional	ids (picked from your account)	Label
`expectedCloseDate`optional	date-time (ISO)	Please enter date in YYYY-MM-DD format.
`visibleTo`optional	one of "1" \| "3"	Visible To
`channel`optional	id (picked from your account)	Channel
`leadValue`optional	number	Lead Value Amount
`leadValueCurrency`optional	text	The currency of the lead value (e.g., "USD", "EUR").
`customfields`optional	object (depends on other props)	Custom Fields

update-organization

Update Organization. Updates an existing organization.

Input	Type	Description
`organizationId`required	number	You can use Find Organization action to retrieve org ID.
`name`optional	text	Name
`ownerId`optional	id (picked from your account)	Owner
`visibleTo`optional	one of "1" \| "3"	Visible To
`labelIds`optional	ids (picked from your account)	Label
`address`optional	long text	Address
`customfields`optional	object (depends on other props)	Custom Fields

update-person

Update Person. Updates an existing person.

Input	Type	Description
`personId`required	number	You can use Find Person action to retrieve person ID.
`name`optional	text	Name
`ownerId`optional	id (picked from your account)	Owner
`organizationId`optional	number	You can use Find Organization action to retrieve org ID.
`email`optional	array	Email
`phone`optional	array	Phone
`labelIds`optional	ids (picked from your account)	Label
`firstName`optional	text	First Name
`lastName`optional	text	Last Name
`visibleTo`optional	one of "1" \| "3"	Visible To
`marketing_status`optional	one of "no_consent" \| "unsubscribed" \| "subscribed" \| "archived"	Marketing opt-in status
`customfields`optional	object (depends on other props)	Custom Fields

update-product

Update Product. Updates an existing product.

Input	Type	Description
`id`required	text	Product ID
`name`optional	text	Name
`code`optional	text	Code
`description`optional	long text	Description
`unit`optional	text	Unit
`tax`optional	number	Tax percentage
`isActive`optional	boolean	Is Active ?
`ownerId`optional	id (picked from your account)	Owner
`currency`optional	text	Please enter currency code (e.g., "USD", "EUR").
`price`optional	number	Price
`cost`optional	number	Cost
`overheadCost`optional	number	Overhead Cost
`visibleTo`optional	one of "1" \| "3"	Visible To
`customfields`optional	object (depends on other props)	Custom Fields

Details

Id: pipedrive
Category: CRM and sales
Tags: crm, sales, pipeline, deals
Package: @activepieces/piece-pipedrive@0.8.6
Tier: Built in