Create or Update User with Vero API on New Cancelled Order (Instant) from Shopify Developer App API

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

Trigger workflow on

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

Next, do this

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

Select this integration
Configure the New Cancelled Order (Instant) trigger
1. Connect your Shopify Developer App account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Create or Update User action
1. Connect your Vero account
2. Configure ID
3. Configure Email
4. Optional- Configure Channels
5. Optional- Configure Data
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 Cancelled Order (Instant) on Shopify Developer App

Description:Emit new event each time a new order is cancelled.

Version:0.0.2

Key:shopify_developer_app-new-cancelled-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-cancelled-order",
  name: "New Cancelled Order (Instant)",
  type: "source",
  description: "Emit new event each time a new order is cancelled.",
  version: "0.0.2",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTopic() {
      return constants.EVENT_TOPIC.ORDERS_CANCELLED;
    },
    generateMeta(resource) {
      const ts = Date.parse(resource.updated_at);
      return {
        id: ts,
        summary: `Order Cancelled ${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 or Update User on Vero

Description:This endpoint creates a new user profile if the user doesn't exist yet. Otherwise, the user profile is updated based on the properties provided. [See the documentation](https://developers.getvero.com/track-api-reference/#/operations/identify)

Version:0.0.2

Key:vero-create-or-update-user

View on GitHub

Vero Overview#

Vero's API allows you to automate email marketing tasks such as managing campaigns, users, and events. Integrating Vero with Pipedream enables you to create workflows that respond to various triggers, like webhooks or schedules, and carry out actions such as sending emails, segmenting users, or tracking events. This integration can be a powerful tool to personalize your marketing efforts and respond in real-time to your customers' interactions.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import app from "../../vero.app.mjs";

export default {
  type: "action",
  key: "vero-create-or-update-user",
  name: "Create or Update User",
  version: "0.0.2",
  description: "This endpoint creates a new user profile if the user doesn't exist yet. Otherwise, the user profile is updated based on the properties provided. [See the documentation](https://developers.getvero.com/track-api-reference/#/operations/identify)",
  props: {
    app,
    id: {
      propDefinition: [
        app,
        "id",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    channels: {
      type: "string[]",
      label: "Channels",
      description: "A valid JSON array containing hashes of key/value pairs that represent the user's device token. Each hash should represent a single device token and include the fields type, address, and platform. Ex: `{\"type\":\"push\", \"address\":\"UNIQUE_DEVICE_TOKEN\", \"platform\":\"android\"}`",
      optional: true,
    },
    data: {
      type: "object",
      label: "Data",
      description: "A valid JSON hash containing key value pairs that represent the custom user properties you want to update. The locale, timezone and userAgent attributes are reserved properties that may be updated automatically by our SDKs. You can use these properties but bear in mind they may be overwritten if using our SDKs or integrations. All other keys are freeform and can be defined by you. Ex: `{\"first_name\":\"Damien\",\"last_name\":\"Brzoska\",\"timezone\":-10}`",
      optional: true,
    },
  },
  methods: {
    parseChannels(data) {
      if (!data) {
        return null;
      }
      const parsed = [];
      for (let i = 0; i < data.length; i++) {
        let item;
        try {
          item = JSON.parse(data[i]);
        } catch (err) {
          throw new ConfigurationError(`Invalid JSON in channels property at index ${i}: ${err.message}`);
        }

        if (Array.isArray(item)) {
          throw new ConfigurationError(`Invalid JSON in channels property at index ${i}: Expected an object, but received an array. If you want to send multiple items, please create a new child`);
        }

        parsed.push(item);
      }

      return parsed;
    },
  },
  async run({ $ }) {
    const {
      app,
      parseChannels,
      ...rest
    } = this;
    const res = await app.createOrUpdateUser({
      ...rest,
      channels: parseChannels(rest.channels),
    });
    $.export("summary", `User with id "${rest.id}" created or updated successfully`);
    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
Vero	`app`	`app`	This component uses the Vero app.
ID	`id`	`string`	The unique identifier of the customer.
Email	`email`	`string`	The email address of the customer.
Channels	`channels`	`string[]`	A valid JSON array containing hashes of key/value pairs that represent the user's device token. Each hash should represent a single device token and include the fields type, address, and platform. Ex: `{"type":"push", "address":"UNIQUE_DEVICE_TOKEN", "platform":"android"}`
Data	`data`	`object`	A valid JSON hash containing key value pairs that represent the custom user properties you want to update. The locale, timezone and userAgent attributes are reserved properties that may be updated automatically by our SDKs. You can use these properties but bear in mind they may be overwritten if using our SDKs or integrations. All other keys are freeform and can be defined by you. Ex: `{"first_name":"Damien","last_name":"Brzoska","timezone":-10}`

Action Authentication#

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

To retrieve your Auth Token,

Navigate to your Vero account and sign in
Go to “Configuration” > “Settings” > “Project Details” > "API Credentials" > Auth Token