Create Document with Docupilot API on New Draft Order (Instant) from Shopify Developer App API

Pipedream makes it easy to connect APIs for Docupilot, Shopify Developer App and 2,000+ other apps remarkably fast.

Trigger workflow on

New Draft Order (Instant) from the Shopify Developer App API

Next, do this

Create Document with the Docupilot API

No credit card required

▶

Watch us build a workflow

8 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 Shopify Developer App trigger and Docupilot 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 Developer App account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Create Document action
1. Connect your Docupilot account
2. Configure Template URL
3. Configure Template Tokens
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 Developer App

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

Version:0.0.2

Key:shopify_developer_app-new-draft-order

View on GitHub

Shopify Developer App 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 common from "../common/webhook.mjs";
import constants from "../common/constants.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.2",
  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 Developer App	`app`	`app`	This component uses the Shopify Developer App 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
Private Metafield Namespaces	`privateMetafieldNamespaces`	`string[]`	Array of namespaces for any private metafields that should be included with each webhook

Trigger Authentication#

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

Find your Shop ID

Get your Access Token

Next, 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 Developer App#

Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.

Action#

Create Document on Docupilot

Description:Create a document [See docs here](https://help.docupilot.app/create-document/api-and-webhook-integration#api-integration)

Version:0.0.1

Key:docupilot-create-document

View on GitHub

Docupilot Overview#

Docupilot offers powerful document automation capabilities, allowing you to create dynamic documents based on templates and data inputs. With the Docupilot API, you can integrate this functionality directly into Pipedream workflows, triggering document generation from a myriad of events and data sources. Think of automating contract creation when a new deal is won in your CRM, or sending personalized letters en masse with the click of a button. The API empowers you to craft, distribute, and manage documents efficiently and programmatically.

Action Code#

import docupilot from "../../app/docupilot.app.mjs";
import { defineAction } from "@pipedream/types";
import { ConfigurationError } from "@pipedream/platform";
export default defineAction({
    name: "Create Document",
    description: "Create a document [See docs here](https://help.docupilot.app/create-document/api-and-webhook-integration#api-integration)",
    key: "docupilot-create-document",
    version: "0.0.1",
    type: "action",
    props: {
        docupilot,
        templateUrl: {
            type: "string",
            label: "Template URL",
            description: `Choose a template in the Docupilot dashboard, and go to the **Create** tab, then to **API integrations**.
        \\
        Copy the ***POST Merge URL*** here. Example: \`https://api.docupilot.app/documents/create/46ac75c3/5e7d03ec\``,
        },
        tokens: {
            type: "object",
            label: "Template Tokens",
            description: `The tokens used in this template (as object keys) and their values.
       \\
       Objects and arrays should be in JSON-stringified format.
       \\
       If you need to include characters such as \`{}[]\` in a value, and it should not be parsed as an object or array, prefix the key with \`$\`.`,
        },
    },
    async run({ $ }) {
        const url = this.templateUrl.trim();
        const baseUrl = this.docupilot._createDocumentBaseUrl();
        if (!url.startsWith(baseUrl)) {
            throw new ConfigurationError("Invalid `Template URL`. Check the prop and make sure you copied the URL properly.");
        }
        const data = {};
        const tokens = this.tokens;
        if (tokens) {
            Object.entries(tokens).forEach(([key, value,]) => {
                try {
                    if (!key.startsWith("$") && value.match(/({[^}]*})|(\[[^\]]*\])/)) {
                        value = JSON.parse(value);
                    }
                }
                catch (err) {
                    throw new ConfigurationError(`Error parsing JSON value for key \`${key}\`: *"${err}"*
            \\
            If this is not a JSON string for an object or array, prefix the key with \`$\` as in \`$${key}\``);
                }
                data[key.startsWith("$")
                    ? key.slice(1)
                    : key] = value;
            });
        }
        const params = {
            $,
            url,
            data,
        };
        const response = await this.docupilot.createDocument(params);
        $.export("$summary", "Created document successfully");
        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
Docupilot	`docupilot`	`app`	This component uses the Docupilot app.
Template URL	`templateUrl`	`string`	Choose a template in the Docupilot dashboard, and go to the Create tab, then to API integrations. Copy the POST Merge URL here. Example: `https://api.docupilot.app/documents/create/46ac75c3/5e7d03ec`
Template Tokens	`tokens`	`object`	The tokens used in this template (as object keys) and their values. Objects and arrays should be in JSON-stringified format. If you need to include characters such as `{}[]` in a value, and it should not be parsed as an object or array, prefix the key with `$`.