Add Contacts to Sequence with Apollo.io API on New Cancelled Order (Instant) from Shopify Developer App API

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

Add Contacts to Sequence with the Apollo.io 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 Apollo.io 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 Add Contacts to Sequence action
1. Connect your Apollo.io account
2. Select a Sequence ID
3. Select one or more Contact IDs
4. Select a Email Account ID
5. Optional- Configure Sequence No Email
6. Optional- Configure Sequence Active in Other Campaigns
7. Optional- Configure Sequence Finished in Other Campaigns
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#

Add Contacts to Sequence on Apollo.io

Description:Adds one or more contacts to a sequence in Apollo.io. [See the documentation](https://apolloio.github.io/apollo-api-docs/?shell#add-contacts-to-sequence)

Version:0.0.2

Key:apollo_io-add-contacts-to-sequence

View on GitHub

Apollo.io Overview#

The Apollo.io API on Pipedream enables you to automate sales processes by giving you programmatic access to your Apollo.io data. Through this API, you can manage leads, contacts, and opportunities, or sync data with your CRM. Pipedream's serverless platform allows you to connect Apollo.io with hundreds of other apps to automate workflows like lead enrichment, data syncing between apps, and triggering personalized communication based on prospect actions.

Action Code#

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

export default {
  key: "apollo_io-add-contacts-to-sequence",
  name: "Add Contacts to Sequence",
  description: "Adds one or more contacts to a sequence in Apollo.io. [See the documentation](https://apolloio.github.io/apollo-api-docs/?shell#add-contacts-to-sequence)",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    sequenceId: {
      propDefinition: [
        app,
        "sequenceId",
      ],
    },
    contactIds: {
      propDefinition: [
        app,
        "contactId",
      ],
      type: "string[]",
      label: "Contact IDs",
      description: "Identifiers of the contacts to add to sequence",
    },
    emailAccountId: {
      propDefinition: [
        app,
        "emailAccountId",
      ],
    },
    sequenceNoEmail: {
      type: "boolean",
      label: "Sequence No Email",
      description: "  Whether to still sequence the contact if he/she does not have an email address",
      optional: true,
    },
    sequenceActiveInOtherCampaigns: {
      type: "boolean",
      label: "Sequence Active in Other Campaigns",
      description: "Whether to still sequence the contact if he/she is active or paused in another sequence",
      optional: true,
    },
    sequenceFinishedInOtherCampaigns: {
      type: "boolean",
      label: "Sequence Finished in Other Campaigns",
      description: "Whether to still sequence the contact if he/she already finished another sequence",
      optional: true,
    },
  },
  async run({ $ }) {
    const { contacts } = await this.app.addContactsToSequence({
      $,
      sequenceId: this.sequenceId,
      data: {
        contact_ids: this.contactIds,
        emailer_campaign_id: this.sequenceId,
        send_email_from_email_account_id: this.emailAccountId,
        sequence_no_email: this.sequenceNoEmail,
        sequence_active_in_other_campaigns: this.sequenceActiveInOtherCampaigns,
        sequence_finished_in_other_campaigns: this.sequencFinishedInOtherCampaigns,
      },
    });

    $.export("$summary", `Successfully added ${contacts.length} contact${contacts.length === 1
      ? ""
      : "s"} to sequence.`);

    return contacts;
  },
};

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
Apollo.io	`app`	`app`	This component uses the Apollo.io app.
Sequence ID	`sequenceId`	`string`	Select a value from the drop down menu.
Contact IDs	`contactIds`	`string[]`	Select a value from the drop down menu.
Email Account ID	`emailAccountId`	`string`	Select a value from the drop down menu.
Sequence No Email	`sequenceNoEmail`	`boolean`	Whether to still sequence the contact if he/she does not have an email address
Sequence Active in Other Campaigns	`sequenceActiveInOtherCampaigns`	`boolean`	Whether to still sequence the contact if he/she is active or paused in another sequence
Sequence Finished in Other Campaigns	`sequenceFinishedInOtherCampaigns`	`boolean`	Whether to still sequence the contact if he/she already finished another sequence