Create Link with Short.io API on New Order from BigCommerce API

Pipedream makes it easy to connect APIs for Short.io, BigCommerce and 3,000+ other apps remarkably fast.

Trigger workflow on

New Order from the BigCommerce API

Next, do this

Create Link with the Short.io 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 Short.io action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Order trigger
1. Connect your BigCommerce account
Configure the Create Link action
1. Connect your Short.io account
2. Select a Domain Id
3. Configure Original URL
4. Optional- Configure Path
5. Optional- Configure Title
6. Optional- Configure Tags
7. Optional- Configure Allow duplicates
8. Optional- Configure Expires at
9. Optional- Configure Expired URL
10. Optional- Configure iPhone URL
11. Optional- Configure Android URL
12. Optional- Configure password
13. Optional- Configure UTM Source
14. Optional- Configure UTM Medium
15. Optional- Configure UTM Campaign
16. Optional- Configure UTM Term
17. Optional- Configure UTM Content
18. Optional- Configure Cloaking
19. Optional- Select a Redirect type
20. Optional- Select a Folder ID
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 Order on BigCommerce

Description:Emit new created order

Version:0.0.2

Key:bigcommerce-new-order

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 common from "../common/base.mjs";

export default {
  ...common,
  name: "New Order",
  version: "0.0.2",
  type: "source",
  key: "bigcommerce-new-order",
  description: "Emit new created order",
  hooks: {
    ...common.hooks,
    async activate() {
      const hookId = await this.bigcommerce.createHook(
        this.http.endpoint,
        "order",
      );
      this.setHookId(hookId);
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "Order 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.

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#

Create Link on Short.io

Description:Create a Short Link. [See the documentation](https://developers.short.io/reference/linkspost).

Version:0.1.1

Key:short-create-a-link

View on GitHub

Short.io Overview#

Short.io provides a robust API for URL shortening, allowing you to create, delete, and track shortened links programmatically. By integrating with Pipedream, you can automate link creation or aggregation of click data in real-time, triggering workflows in response to events like link clicks or creating short links in bulk from a data source.

Action Code#

import shortApp from "../../short.app.mjs";
import common from "../common/common.mjs";
import lodash from "lodash";

const {
  props: { // eslint-disable-next-line no-unused-vars
    domain, ...props
  },
} = common;

export default {
  key: "short-create-a-link",
  name: "Create Link",
  description: "Create a Short Link. [See the documentation](https://developers.short.io/reference/linkspost).",
  version: "0.1.1",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    shortApp,
    domainId: {
      propDefinition: [
        shortApp,
        "domainId",
      ],
    },
    ...props,
    folderId: {
      propDefinition: [
        shortApp,
        "folderId",
        ({ domainId }) => ({
          domainId,
        }),
      ],
    },
  },
  async run({ $ }) {
    const param = lodash.pick(this, [
      "originalURL",
      "path",
      "title",
      "tags",
      "allowDuplicates",
      "expiresAt",
      "expiredURL",
      "iphoneURL",
      "androidURL",
      "password",
      "utmSource",
      "utmMedium",
      "utmCampaign",
      "utmTerm",
      "utmContent",
      "cloaking",
      "redirectType",
      "folderId",
    ]);
    const { hostname: domain } = await this.shortApp.getDomainInfo(this.domainId);
    const link = await this.shortApp.createLink($, {
      domain,
      ...param,
    });
    $.export("$summary", `Successfully created the link: ${link.secureShortURL}`);
    return link;
  },
};

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
Short.io	`shortApp`	`app`	This component uses the Short.io app.
Domain Id	`domainId`	`integer`	Select a value from the drop down menu.
Original URL	`originalURL`	`string`	Link, which you want to shorten.
Path	`path`	`string`	Optional path part of newly created link. If empty - it will be generated automatically.
Title	`title`	`string`	Title of created URL to be shown in short.io admin panel.
Tags	`tags`	`string[]`	Specify the tags of your link.
Allow duplicates	`allowDuplicates`	`boolean`	Specify whether to allow repeated links to be registered.
Expires at	`expiresAt`	`string`	Link expiration date, use `yyyy-mm-dd` format. If no expiration date is given (default), link will never expire.
Expired URL	`expiredURL`	`string`	URL to redirect when the link is expired.
iPhone URL	`iphoneURL`	`string`	If users open the URL with iPhone, they will be redirected to this URL.
Android URL	`androidURL`	`string`	If users open the URL with Android, they will be redirected to this URL
password	`password`	`string`	Requires Personal plan. Password to be asked when user visits a link. This password will not be stored in plain text, we will hash it with salt.
UTM Source	`utmSource`	`string`	The referrer: (e.g. google, newsletter).
UTM Medium	`utmMedium`	`string`	Marketing medium: (e.g. cpc, banner, email).
UTM Campaign	`utmCampaign`	`string`	Product, promo code, or slogan (e.g. spring_sale).
UTM Term	`utmTerm`	`string`	Identify the paid keywords.
UTM Content	`utmContent`	`string`	Use to differentiate ads.
Cloaking	`cloaking`	`boolean`	Specify whether to cloak the link.
Redirect type	`redirectType`	`integer`	Select a value from the drop down menu:`{ "label": "301 Moved Permanently", "value": 301 }{ "label": "302 Found", "value": 302 }{ "label": "303 See Other", "value": 303 }{ "label": "307 Temporary Redirect", "value": 307 }{ "label": "308 Permanent Redirect", "value": 308 }`
Folder ID	`folderId`	`string`	Select a value from the drop down menu.