Create Document with Docupilot API on New Event Emitted (Instant) from Shopify API

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

Trigger workflow on

New Event Emitted (Instant) from the Shopify 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 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Shopify 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 Event Emitted (Instant) trigger
1. Connect your Shopify account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
4. Select a Event Topic
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 Event Emitted (Instant) on Shopify

Description:Emit new event for each new Shopify event.

Version:0.0.5

Key:shopify_developer_app-new-event-emitted

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-event-emitted",
  name: "New Event Emitted (Instant)",
  type: "source",
  description: "Emit new event for each new Shopify event.",
  version: "0.0.5",
  dedupe: "unique",
  props: {
    ...common.props,
    topic: {
      type: "string",
      label: "Event Topic",
      description: "Event topic that triggers the webhook.",
      options: constants.EVENT_TOPICS,
    },
  },
  methods: {
    ...common.methods,
    getTopic() {
      return this.topic;
    },
    generateMeta() {
      const ts = Date.now();
      return {
        id: ts,
        summary: `New Event Emitted at ${new Date(ts)}.`,
        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`.
Event Topic	`topic`	`string`	Select a value from the drop down menu:`app/uninstalledbulk_operations/finishcarts/createcarts/updatecheckouts/createcheckouts/deletecheckouts/updatecollection_listings/addcollection_listings/removecollection_listings/updatecollections/createcollections/deletecollections/updatecustomer_groups/createcustomer_groups/deletecustomer_groups/updatecustomer_payment_methods/createcustomer_payment_methods/revokecustomer_payment_methods/updatecustomers_marketing_consent/updatecustomers/createcustomers/deletecustomers/disablecustomers/enablecustomers/updatedisputes/createdisputes/updatedomains/createdomains/destroydomains/updatedraft_orders/createdraft_orders/deletedraft_orders/updatefulfillment_events/createfulfillment_events/deletefulfillments/createfulfillments/updateinventory_items/createinventory_items/deleteinventory_items/updateinventory_levels/connectinventory_levels/disconnectinventory_levels/updatelocales/createlocales/updatelocations/createlocations/deletelocations/updatemarkets/createmarkets/deletemarkets/updateorder_transactions/createorders/cancelledorders/createorders/deleteorders/editedorders/fulfilledorders/paidorders/partially_fulfilledorders/updatedproduct_listings/addproduct_listings/removeproduct_listings/updateproducts/createproducts/deleteproducts/updateprofiles/createprofiles/deleteprofiles/updaterefunds/createscheduled_product_listings/addscheduled_product_listings/removescheduled_product_listings/updateselling_plan_groups/createselling_plan_groups/deleteselling_plan_groups/updateshop/updatesubscription_billing_attempts/challengedsubscription_billing_attempts/failuresubscription_billing_attempts/successsubscription_contracts/createsubscription_contracts/updatetender_transactions/createthemes/createthemes/deletethemes/publishevent-topics-themes-updatethemes/update`

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#

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 `$`.

Create Document with Docupilot API on New Event Emitted (Instant) from Shopify API

Pipedream makes it easy to connect APIs for Docupilot, 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