← Pipedrive

Add Deal with Pipedrive API

Pipedream makes it easy to connect APIs for Pipedrive and 900+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add Deal with the Pipedrive API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Add Deal with the Pipedrive API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add Deal action
    1. Connect your Pipedrive account
    2. Configure Title
    3. Optional- Configure Value
    4. Optional- Configure Currency
    5. Optional- Select a User ID
    6. Optional- Select a Person ID
    7. Optional- Select a Organization ID
    8. Optional- Select a Stage ID
    9. Optional- Select a Status
    10. Optional- Configure Probability
    11. Optional- Configure Lost Reason
    12. Optional- Select a Visible To
    13. Optional- Configure Add Time
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Add Deal with Pipedrive API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Pipedrive
 
Try it
Add Deal with Pipedrive API on New Item in Feed from RSS API
RSS + Pipedrive
 
Try it
Add Deal with Pipedrive API on New Message from Discord API
Discord + Pipedrive
 
Try it
Add Deal with Pipedrive API on New Message In Channels from Slack API
Slack + Pipedrive
 
Try it
Add Deal with Pipedrive API on New Message in Channel from Discord Bot API
Discord Bot + Pipedrive
 
Try it

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Deal on Pipedrive
Description:Adds a new deal. See the Pipedrive API docs for Deals [here](https://developers.pipedrive.com/docs/api/v1/Deals#addDeal)
Version:0.1.2
Key:pipedrive-add-deal

Code

import pipedriveApp from "../../pipedrive.app.mjs";

export default {
  key: "pipedrive-add-deal",
  name: "Add Deal",
  description: "Adds a new deal. See the Pipedrive API docs for Deals [here](https://developers.pipedrive.com/docs/api/v1/Deals#addDeal)",
  version: "0.1.2",
  type: "action",
  props: {
    pipedriveApp,
    title: {
      propDefinition: [
        pipedriveApp,
        "dealTitle",
      ],
    },
    value: {
      propDefinition: [
        pipedriveApp,
        "dealValue",
      ],
    },
    currency: {
      propDefinition: [
        pipedriveApp,
        "dealCurrency",
      ],
    },
    userId: {
      propDefinition: [
        pipedriveApp,
        "userId",
      ],
    },
    personId: {
      propDefinition: [
        pipedriveApp,
        "personId",
      ],
    },
    organizationId: {
      propDefinition: [
        pipedriveApp,
        "organizationId",
      ],
    },
    stageId: {
      propDefinition: [
        pipedriveApp,
        "stageId",
      ],
    },
    status: {
      propDefinition: [
        pipedriveApp,
        "status",
      ],
    },
    probability: {
      propDefinition: [
        pipedriveApp,
        "probability",
      ],
    },
    lostReason: {
      propDefinition: [
        pipedriveApp,
        "lostReason",
      ],
    },
    visibleTo: {
      propDefinition: [
        pipedriveApp,
        "visibleTo",
      ],
    },
    addTime: {
      propDefinition: [
        pipedriveApp,
        "addTime",
      ],
    },
  },
  async run({ $ }) {
    const {
      title,
      value,
      currency,
      userId,
      personId,
      organizationId,
      stageId,
      status,
      probability,
      lostReason,
      visibleTo,
      addTime,
    } = this;

    try {
      const resp =
        await this.pipedriveApp.addDeal({
          title,
          value,
          currency,
          user_id: userId,
          person_id: personId,
          org_id: organizationId,
          stage_id: stageId,
          status,
          probability,
          lost_reason: lostReason,
          visible_to: visibleTo,
          add_time: addTime,
        });

      $.export("$summary", "Successfully added deal");

      return resp;
    } catch (error) {
      console.error(error.context?.body || error);
      throw error.context?.body?.error || "Failed to add deal";
    }
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
PipedrivepipedriveAppappThis component uses the Pipedrive app.
Titletitlestring

Deal title

Valuevaluestring

Value of the deal. If omitted, value will be set to 0.

Currencycurrencystring

Currency of the deal. Accepts a 3-character currency code. If omitted, currency will be set to the default currency of the authorized user.

User IDuserIdintegerSelect a value from the drop down menu.
Person IDpersonIdintegerSelect a value from the drop down menu.
Organization IDorganizationIdintegerSelect a value from the drop down menu.
Stage IDstageIdintegerSelect a value from the drop down menu.
StatusstatusstringSelect a value from the drop down menu:openwonlostdeleted
Probabilityprobabilityinteger

Deal success probability percentage. Used/shown only when deal_probability for the pipeline of the deal is enabled.

Lost ReasonlostReasonstring

Optional message about why the deal was lost (to be used when status=lost)

Visible TovisibleTostringSelect a value from the drop down menu:{ "label": "Owner & followers (private)", "value": "1" }{ "label": "Entire company (shared)", "value": "3" }
Add TimeaddTimestring

Optional creation date & time of the deal in UTC. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

Authentication

Pipedrive uses OAuth authentication. When you connect your Pipedrive account, Pipedream will open a popup window where you can sign into Pipedrive and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Pipedrive API.

Pipedream requests the following authorization scopes when you connect your account:

About Pipedrive

Sales CRM & Pipeline Management Software

More Ways to Use Pipedrive

Triggers

New Deal from the Pipedrive API

Triggers when a new deal is created.

 
Try it
New Person from the Pipedrive API

Triggers when a new person is created.

 
Try it
Updated Deal from the Pipedrive API

Triggers when a deal is updated.

 
Try it
Updated Person from the Pipedrive API

Triggers when a person is updated.

 
Try it

Actions

Add Activity with the Pipedrive API

Adds a new activity. Includes more_activities_scheduled_in_context property in response's additional_data which indicates whether there are more undone activities scheduled with the same deal, person or organization (depending on the supplied data). See the Pipedrive API docs for Activities here. For info on adding an activity in Pipedrive

 
Try it
Add Organization with the Pipedrive API

Adds a new organization. See the Pipedrive API docs for Organizations here

 
Try it
Add Person with the Pipedrive API

Adds a new person. See the Pipedrive API docs for People here

 
Try it
Search persons with the Pipedrive API

Searches all Persons by name, email, phone, notes and/or custom fields. This endpoint is a wrapper of /v1/itemSearch with a narrower OAuth scope. Found Persons can be filtered by Organization ID. See the Pipedrive API docs here

 
Try it
Update Deal with the Pipedrive API

Updates the properties of a deal. See the Pipedrive API docs for Deals here

 
Try it