Add Lead with Pipedrive API on New Custom Events from BigCommerce API

Pipedream makes it easy to connect APIs for Pipedrive, BigCommerce and 2,700+ other apps remarkably fast.

Trigger workflow on

New Custom Events from the BigCommerce API

Next, do this

Add Lead with the Pipedrive API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a BigCommerce trigger and Pipedrive action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Custom Events trigger
1. Connect your BigCommerce account
2. Configure Using channel
Configure the Add Lead action
1. Connect your Pipedrive account
2. Configure Title
3. Optional- Select a Person ID
4. Optional- Select a Organization ID
5. Optional- Select a User ID
6. Optional- Select one or more Lead Label IDs
7. Optional- Configure Value
8. Optional- Configure Expected Close Date
9. Optional- Select a Visible To
10. Optional- Configure Was Seen
11. Optional- Configure Note
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Custom Events on BigCommerce

Description:Emit new custom webhook event

Version:0.0.2

Key:bigcommerce-custom-events

View on GitHub

BigCommerce Overview#

The BigCommerce API enables merchants to seamlessly manage their e-commerce operations by automating tasks, syncing data, and integrating with a plethora of other services. With Pipedream, you can tap into the BigCommerce API to create custom workflows that handle everything from order processing to customer relationship management. The result is a more efficient, personalized shopping experience for customers and less manual work for store owners.

Trigger Code#

import bigcommerce from "../../bigcommerce.app.mjs";
import constants from "../../common/constants.mjs";
import { filterObj } from "../../utils.mjs";
import common from "../common/base.mjs";

export default {
  ...common,
  name: "New Custom Events",
  version: "0.0.2",
  type: "source",
  key: "bigcommerce-custom-events",
  description: "Emit new custom webhook event",
  props: {
    ...common.props,
    channel: {
      propDefinition: [
        bigcommerce,
        "channel",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.channel) {
      props.channelId = {
        type: "string",
        label: "Channel Id",
        description: "Id of the channel",
      };
    }

    props.type = {
      type: "string",
      label: "Webhook type",
      description: "Type of the webhook",
      options: Object.getOwnPropertyNames(
        filterObj(
          constants.WEBHOOK_SCOPES,
          (scope) => !!scope[this.channel
            ? "channel"
            : "default"],
        ),
      ),
      reloadProps: true,
    };

    if (this.type) {
      const scope = constants.WEBHOOK_SCOPES[this.type];
      props.scope = {
        type: "string",
        label: "Scope of the webhook",
        options: this.channel
          ? scope.channel
          : scope.default,
      };
    }

    return props;
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const hookId = await this.bigcommerce.createHook(
        this.http.endpoint,
        this.type,
        this.scope,
        this.channel,
        this.channelId,
      );
      this.setHookId(hookId);
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "Custom event created";
    },
  },
};

Trigger 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.

Label	Prop	Type	Description
BigCommerce	`bigcommerce`	`app`	This component uses the BigCommerce app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Using channel	`channel`	`boolean`	Channel of the webhook

Trigger Authentication#

BigCommerce uses API keys for authentication. When you connect your BigCommerce account, Pipedream securely stores the keys so you can easily authenticate to BigCommerce APIs in both code and no-code steps.

Navigate to Settings > API > Store-level API accounts
Name the account (it will only be visible to store users)
In the OAuth Scopes section, select the minimum scopes the app will require
Press Save.

The base API path will look something like this: https://api.bigcommerce.com/stores/123456/

In example above, the store_hash is 123456. Enter this and the access token below.

About BigCommerce#

Ecommerce for a New Era

Action#

Add Lead on Pipedrive

Description:Create a new lead in Pipedrive. [See the documentation](https://developers.pipedrive.com/docs/api/v1/Leads#addLead)

Version:0.0.3

Key:pipedrive-add-lead

View on GitHub

Pipedrive Overview#

Pipedrive API on Pipedream allows you to create powerful sales automation and data management workflows. With access to Pipedrive's CRM capabilities, you can automate deal updates, contact management, and sales reporting. Whether you're syncing customer information across platforms or triggering actions based on deal stages, Pipedream makes these integrations seamless.

Action Code#

import pipedrive from "../../pipedrive.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "pipedrive-add-lead",
  name: "Add Lead",
  description: "Create a new lead in Pipedrive. [See the documentation](https://developers.pipedrive.com/docs/api/v1/Leads#addLead)",
  version: "0.0.3",
  type: "action",
  props: {
    pipedrive,
    title: {
      type: "string",
      label: "Title",
      description: "The name of the lead",
    },
    personId: {
      propDefinition: [
        pipedrive,
        "personId",
      ],
      description: "The ID of a person which this lead will be linked to. If the person does not exist yet, it needs to be created first. This property is required unless organization_id is specified.",
    },
    organizationId: {
      propDefinition: [
        pipedrive,
        "organizationId",
      ],
      description: "The ID of an organization which this lead will be linked to. If the organization does not exist yet, it needs to be created first. This property is required unless person_id is specified.",
    },
    ownerId: {
      propDefinition: [
        pipedrive,
        "userId",
      ],
      description: "The ID of the user which will be the owner of the created lead. If not provided, the user making the request will be used.",
    },
    leadLabelIds: {
      propDefinition: [
        pipedrive,
        "leadLabelIds",
      ],
    },
    value: {
      type: "object",
      label: "Value",
      description: "Potential value of the lead, e.g. `{ \"amount\": 200, \"currency\": \"EUR\" }`",
      optional: true,
    },
    expectedCloseDate: {
      type: "string",
      label: "Expected Close Date",
      description: "The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.",
      optional: true,
    },
    visibleTo: {
      type: "string",
      label: "Visible To",
      description: "The visibility of the lead. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups [here](https://support.pipedrive.com/en/article/visibility-groups).",
      options: [
        {
          label: "Essential / Advanced plan - Owner & followers, Professional / Enterprise plan - Owner only",
          value: "1",
        },
        {
          label: "Essential / Advanced plan - Entire company, Professional / Enterprise plan - Owner's visibility group",
          value: "3",
        },
        {
          label: "Professional / Enterprise plan - Owner's visibility group and sub-groups",
          value: "5",
        },
        {
          label: "Professional / Enterprise plan - Entire company",
          value: "7",
        },
      ],
      optional: true,
    },
    wasSeen: {
      type: "boolean",
      label: "Was Seen",
      description: "A flag indicating whether the lead was seen by someone in the Pipedrive UI",
      optional: true,
    },
    note: {
      type: "string",
      label: "Note",
      description: "A note to add to the lead",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.organizationId && !this.personId) {
      throw new ConfigurationError("Either organizationId or personId is required");
    }

    const response = await this.pipedrive.addLead({
      title: this.title,
      person_id: this.personId,
      organization_id: this.organizationId,
      owner_id: this.ownerId,
      label_ids: this.leadLabelIds,
      value: parseObject(this.value),
      expected_close_date: this.expectedCloseDate,
      visible_to: this.visibleTo,
      was_seen: this.wasSeen,
    });

    if (this.note) {
      await this.pipedrive.addNote({
        content: this.note,
        lead_id: response.data?.id,
      });
    }

    $.export("$summary", `Successfully created lead: ${response.data?.title || response.data?.id}`);
    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Pipedrive	`pipedrive`	`app`	This component uses the Pipedrive app.
Title	`title`	`string`	The name of the lead
Person ID	`personId`	`integer`	Select a value from the drop down menu.
Organization ID	`organizationId`	`integer`	Select a value from the drop down menu.
User ID	`ownerId`	`integer`	Select a value from the drop down menu.
Lead Label IDs	`leadLabelIds`	`string[]`	Select a value from the drop down menu.
Value	`value`	`object`	Potential value of the lead, e.g. `{ "amount": 200, "currency": "EUR" }`
Expected Close Date	`expectedCloseDate`	`string`	The date of when the deal which will be created from the lead is expected to be closed. In ISO 8601 format: YYYY-MM-DD.
Visible To	`visibleTo`	`string`	Select a value from the drop down menu:`{ "label": "Essential / Advanced plan - Owner & followers, Professional / Enterprise plan - Owner only", "value": "1" }{ "label": "Essential / Advanced plan - Entire company, Professional / Enterprise plan - Owner's visibility group", "value": "3" }{ "label": "Professional / Enterprise plan - Owner's visibility group and sub-groups", "value": "5" }{ "label": "Professional / Enterprise plan - Entire company", "value": "7" }`
Was Seen	`wasSeen`	`boolean`	A flag indicating whether the lead was seen by someone in the Pipedrive UI
Note	`note`	`string`	A note to add to the lead

Action 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:

Add Lead with Pipedrive API on New Custom Events from BigCommerce API

Pipedream makes it easy to connect APIs for Pipedrive, BigCommerce and 2,700+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,700+apps by most popular

1
-
24
of
2,700+
apps by most popular