Add or Update a contact with SendinBlue API on New Cancelled Order (Instant) from Shopify API

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

Trigger workflow on

New Cancelled Order (Instant) from the Shopify API

Next, do this

Add or Update a contact with the SendinBlue 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 SendinBlue 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 account
2. Optional- Configure Metafield Namespaces
3. Optional- Configure Private Metafield Namespaces
Configure the Add or Update a contact action
1. Connect your SendinBlue account
2. Optional- Select a Contact
3. Configure Email
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

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

Version:0.0.4

Key:shopify_developer_app-new-cancelled-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-cancelled-order",
  name: "New Cancelled Order (Instant)",
  type: "source",
  description: "Emit new event each time a new order is cancelled.",
  version: "0.0.4",
  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	`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#

Add or Update a contact on SendinBlue

Description:Add or Update a contact

Version:0.0.1

Key:sendinblue-add-or-update-contact

View on GitHub

SendinBlue Overview#

The SendinBlue API offers a suite of email marketing tools, including campaign creation, contact list management, and transactional email sending. It's designed for crafting personalized messages, automating marketing workflows, and tracking the performance of email campaigns. With Pipedream, you can harness the power of SendinBlue by automating interactions with other services, reacting to events with custom code, and stitching together complex workflows with minimal effort.

Action Code#

import sendinBlueApp from "../../sendinblue.app.mjs";

export default {
  key: "sendinblue-add-or-update-contact",
  name: "Add or Update a contact",
  description: "Add or Update a contact",
  version: "0.0.1",
  type: "action",
  props: {
    sendinBlueApp,
    providedIdentifier: {
      type: "string",
      label: "Contact",
      description: "Email OR ID of the contact, if not present the contact will be inserted, it will be used to search the contact, if it can be found the contact will be updated else it will be inserted",
      optional: true,
      reloadProps: true,
      async options({ prevContext }) {
        return this.sendinBlueApp.getContactsPaginated(prevContext, false);
      },
    },
    email: {
      type: "string",
      label: "Email",
      description: "To either be inserted or updated",
    },
  },
  async additionalProps() {
    const attributesList = await this.sendinBlueApp.getContactAttributes(this);
    const attributesFields = attributesList.attributes
      .filter((attr) => attr.category === "normal")
      .reduce((acc, actual) => {
        acc[`attribute-${actual.name}`] = {
          type: "string",
          label: actual.name.replace(/(^\w|\s\w)(\S*)/g, (_, m1, m2) => m1.toUpperCase() + m2.toLowerCase()),
          description: "To either be inserted or updated",
          optional: true,
        };
        return acc;
      }, {});
    const dynamicProps = {
      ...attributesFields,
      listIds: {
        type: "string[]",
        label: "Lists",
        description: "Array with ids of each list to be either inserted or updated,\n\n**On update the contact will be removed from previous lists**",
        options: async ({ prevContext }) => {
          return this.sendinBlueApp.getListsPaginated(prevContext);
        },
      },
    };
    return dynamicProps;
  },
  async run({ $ }) {
    let identifier = this.providedIdentifier;
    const listIds = Object.keys(this.listIds).map((key) => parseInt(this.listIds[key], 10));
    let contact = null;
    if (identifier) {
      contact = await this.sendinBlueApp.existingContactByIdentifier(
        $,
        encodeURIComponent(identifier),
      );
    }

    const attributes = {
      EMAIL: this.email,
    };
    for (let key of Object.keys(this).filter((k) => k.startsWith("attribute-"))) {
      const attribute = this[key];
      if (attribute) {
        attributes[key.replace("attribute-", "")] = attribute;
      }
    }
    $.export("Defined attributes", attributes);

    if (contact) {
      identifier = contact.id;
      const unlinkListIds = contact.listIds.filter((el) => !listIds.includes(el));
      await this.sendinBlueApp.updateContact(
        $,
        identifier,
        attributes,
        listIds,
        unlinkListIds,
      );
      $.export("$summary", `Successfully updated contact "${identifier}"`);
    } else {
      const inserted = await this.sendinBlueApp.addContact(
        $,
        attributes,
        listIds,
      );
      identifier = inserted.id;
      $.export("$summary", `Successfully inserted contact "${identifier}"`);
    }
    return this.sendinBlueApp.existingContactByIdentifier(
      $,
      encodeURIComponent(identifier),
    );
  },
};

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
SendinBlue	`sendinBlueApp`	`app`	This component uses the SendinBlue app.
Contact	`providedIdentifier`	`string`	Select a value from the drop down menu.
Email	`email`	`string`	To either be inserted or updated

Add or Update a contact with SendinBlue API on New Cancelled Order (Instant) from Shopify API

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