Send a Link with UltraMsg API on New Custom Events from BigCommerce API

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

Trigger workflow on

New Custom Events from the BigCommerce API

Next, do this

Send a Link with the UltraMsg API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a BigCommerce trigger and UltraMsg 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 Send a Link action
1. Connect your UltraMsg account
2. Select a To
3. Configure Link
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#

Send a Link on UltraMsg

Description:Send a link to a specified number. [See the docs here](https://docs.ultramsg.com/api/post/messages/link)

Version:0.0.1

Key:ultramsg-send-link

View on GitHub

UltraMsg Overview#

UltraMsg API offers a suite of messaging capabilities that let you automate WhatsApp messaging. With it, you can send and receive messages, create WhatsApp chatbots, and manage media, enabling a wide range of automated interactions with users. Pipedream acts as a powerful accelerator here, letting you connect UltraMsg to hundreds of other apps to craft custom workflows.

Action Code#

import ultramsg from "../../ultramsg.app.mjs";

export default {
  name: "Send a Link",
  description: "Send a link to a specified number. [See the docs here](https://docs.ultramsg.com/api/post/messages/link)",
  key: "ultramsg-send-link",
  version: "0.0.1",
  type: "action",
  props: {
    ultramsg,
    to: {
      propDefinition: [
        ultramsg,
        "to",
      ],
    },
    link: {
      type: "string",
      label: "Link",
      description: "Link to be sent. (e.g., `https://example.com/`)",
    },
  },
  async run({ $ }) {
    const {
      to,
      link,
    } = this;

    const data = {
      to,
      link,
    };
    const res = await this.ultramsg.sendLink(data, $);
    $.export("$summary", `Link successfully sent to "${to}"`);

    return res;
  },
};

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
UltraMsg	`ultramsg`	`app`	This component uses the UltraMsg app.
To	`to`	`string`	Select a value from the drop down menu.
Link	`link`	`string`	Link to be sent. (e.g., `https://example.com/`)