Send Custom Data with Databox API on New Draft Order (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Databox, Shopify and 2,400+ other apps remarkably fast.

Trigger workflow on

New Draft Order (Instant) from the Shopify API

Next, do this

Send Custom Data with the Databox 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 Shopify trigger and Databox action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Draft Order (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Send Custom Data action
1. Connect your Databox account
2. Select a Metric Key
3. Configure Value
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 Draft Order (Instant) on Shopify

Description:Emit new event for each new draft order submitted to a store.

Version:0.0.4

Key:shopify_developer_app-new-draft-order

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Trigger Code#

import constants from "../common/constants.mjs";
import common from "../common/webhook-metafields.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-draft-order",
  name: "New Draft Order (Instant)",
  type: "source",
  description: "Emit new event for each new draft order submitted to a store.",
  version: "0.0.4",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.DRAFT_ORDERS_CREATE;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.created_at);
      return {
        id: resource.id,
        summary: `New Draft Order ${resource.id}.`,
        ts,
      };
    },
  },
};

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
Shopify	`app`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Metafield Namespaces	`metafieldNamespaces`	`string[]`	Array of namespaces for any metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook. Metafield definitions can be found in your store's Settings -> Custom Data. Select a metafield to view its namespace under "Namespace and key". For example, if the value is `custom.test_metafield`, the namespace is `custom`.

Trigger Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

About Shopify#

Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.

Action#

Send Custom Data on Databox

Description:Sends custom data. [See docs here](https://developers.databox.com/send-data/)

Version:0.0.1

Key:databox-send-custom-data

View on GitHub

Databox Overview#

The Databox API enables you to create custom dashboards, integrating various data sources to track performance metrics in real-time. With Pipedream, you can leverage this API to automate the flow of data between Databox and other applications, creating bespoke monitoring solutions and data-driven workflows that save time and enhance insights.

Action Code#

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

export default {
  name: "Send Custom Data",
  version: "0.0.1",
  key: "databox-send-custom-data",
  description: "Sends custom data. [See docs here](https://developers.databox.com/send-data/)",
  type: "action",
  props: {
    databox,
    metricKey: {
      propDefinition: [
        databox,
        "metricKey",
      ],
    },
    value: {
      label: "Value",
      description: "The value to insert on metric",
      type: "integer",
    },
  },
  async run({ $ }) {
    const response = await this.databox.sendCustomData({
      key: this.metricKey,
      value: this.value,
      date: new Date(),
    });

    if (response.status !== "OK") {
      throw new Error(response.message);
    }

    $.export("$summary", `Successfully pushed data with id ${response.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
Databox	`databox`	`app`	This component uses the Databox app.
Metric Key	`metricKey`	`string`	Select a value from the drop down menu.
Value	`value`	`integer`	The value to insert on metric

Action Authentication#

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

Refer to the Databox documentation to create your token and get started.

About Databox#

Connect your data from any tool and track it from any device. No more logging into dozens of different tools to understand performance — now you and your team can easily connect your data, build and share reports, monitor trends, and discover insights.

More Ways to Connect Databox + Shopify#

Other Popular Integrations#

Send Custom Data with Databox API on New Abandoned Cart from Shopify (Developer App) API

Shopify + Databox

Send Custom Data with Databox API on New Draft Order (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Databox, Shopify and 2,400+ other apps remarkably fast.

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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