Find Project with Roll API on New Custom Events from BigCommerce API

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

Trigger workflow on

New Custom Events from the BigCommerce API

Next, do this

Find Project with the Roll 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 Roll 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 Find Project action
1. Connect your Roll account
2. Optional- Select a Project Id
3. Optional- Select a Company Id
4. Optional- Configure Title
5. Optional- Configure Description
6. Optional- Select one or more Type
7. Optional- Select a Lead Source Id
8. Optional- Select a Status
9. Optional- Select a SubStatus Id
10. Optional- Configure Color
11. Optional- Configure Value
12. Optional- Configure Job Number
13. Optional- Configure Project At Risk
14. Optional- Configure Due Date
15. Optional- Configure Start Date
16. Optional- Configure End Date
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#

Find Project on Roll

Description:Find a project [See the docs here](https://docs.rollhq.com/docs/roll-api#api-url)

Version:0.0.1

Key:roll-find-project

View on GitHub

Roll Overview#

The Roll API serves as a bridge to Roll's project management software, enabling users to automate tasks, manipulate project data, and integrate with countless other apps within the Pipedream ecosystem. By leveraging this API, you can streamline operations, sync data across various platforms, and create custom notifications that power up your project management workflows.

Action Code#

import _ from "lodash";
import moment from "moment";
import roll from "../../roll.app.mjs";

export default {
  key: "roll-find-project",
  name: "Find Project",
  version: "0.0.1",
  description: "Find a project [See the docs here](https://docs.rollhq.com/docs/roll-api#api-url)",
  type: "action",
  props: {
    roll,
    projectId: {
      propDefinition: [
        roll,
        "projectId",
      ],
      optional: true,
    },
    companyId: {
      propDefinition: [
        roll,
        "companyId",
      ],
      optional: true,
    },
    title: {
      propDefinition: [
        roll,
        "title",
      ],
      optional: true,
    },
    description: {
      propDefinition: [
        roll,
        "description",
      ],
      optional: true,
    },
    projectType: {
      propDefinition: [
        roll,
        "projectType",
      ],
      optional: true,
    },
    projectLeadSourceId: {
      propDefinition: [
        roll,
        "projectLeadSourceId",
      ],
      optional: true,
    },
    status: {
      propDefinition: [
        roll,
        "projectStatus",
      ],
      optional: true,
    },
    subStatusId: {
      propDefinition: [
        roll,
        "projectStatus",
        (c) => ({
          parentId: c.status.value,
        }),
      ],
      label: "SubStatus Id",
      optional: true,
    },
    color: {
      propDefinition: [
        roll,
        "color",
      ],
      optional: true,
    },
    value: {
      propDefinition: [
        roll,
        "value",
      ],
      optional: true,
    },
    jobNumber: {
      propDefinition: [
        roll,
        "jobNumber",
      ],
      optional: true,
    },
    projectAtRisk: {
      propDefinition: [
        roll,
        "projectAtRisk",
      ],
      optional: true,
    },
    dueDate: {
      propDefinition: [
        roll,
        "dueDate",
      ],
      optional: true,
    },
    startDate: {
      propDefinition: [
        roll,
        "startDate",
      ],
      optional: true,
    },
    endDate: {
      propDefinition: [
        roll,
        "endDate",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      // eslint-disable-next-line no-unused-vars
      roll,
      ...variables
    } = this;

    if (variables.status) variables.status = variables.status.label;
    if (variables.subStatusId) variables.subStatusId = variables.subStatusId.value;
    if (variables.projectAtRisk) variables.projectAtRisk = +variables.projectAtRisk;
    if (variables.projectType) variables.projectType = variables.projectType.toString();
    if (variables.dueDate) variables.dueDate = moment(new Date(variables.dueDate)).format("YYYY-MM-DDTHH:mm:ss.SSS[Z]");
    if (variables.startDate) variables.startDate = moment(new Date(variables.startDate)).format("YYYY-MM-DDTHH:mm:ss.SSS[Z]");
    if (variables.endDate) variables.endDate = moment(new Date(variables.endDate)).format("YYYY-MM-DDTHH:mm:ss.SSS[Z]");

    let projectLength = 0;
    let offset = 0;
    const limit = 50;
    const responseArray = [];

    do {
      const { project } = await this.roll.makeRequest({
        variables: {
          ..._.pickBy(variables),
          limit,
          offset,
        },
        query: "listProjects",
      });

      projectLength = project.length;
      responseArray.push(...project);
      offset += limit;
    } while (projectLength);

    $.export("$summary", "Projects successfully fetched!");
    return responseArray;
  },
};

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
Roll	`roll`	`app`	This component uses the Roll app.
Project Id	`projectId`	`integer`	Select a value from the drop down menu.
Company Id	`companyId`	`integer`	Select a value from the drop down menu.
Title	`title`	`string`	The project's title
Description	`description`	`string`	The project's description
Type	`projectType`	`integer[]`	Select a value from the drop down menu.
Lead Source Id	`projectLeadSourceId`	`integer`	Select a value from the drop down menu.
Status	`status`	`integer`	Select a value from the drop down menu.
SubStatus Id	`subStatusId`	`integer`	Select a value from the drop down menu.
Color	`color`	`string`	The hexadecimal color code
Value	`value`	`string`	The project's amount.
Job Number	`jobNumber`	`string`	The identification number of the job.
Project At Risk	`projectAtRisk`	`boolean`	Whether the project is at risk or not.
Due Date	`dueDate`	`string`	The date by which the project must be done. Date format: `0000-00-00`
Start Date	`startDate`	`string`	The day by the project must be started. Date format: `0000-00-00`
End Date	`endDate`	`string`	The day by the project must be finish. Date format: `0000-00-00`

Find Project with Roll API on New Custom Events from BigCommerce API

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

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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