Create Message with Vitally API on New Abandoned Cart from Shopify API

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

Trigger workflow on

New Abandoned Cart from the Shopify API

Next, do this

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

Select this integration
Configure the New Abandoned Cart trigger
1. Connect your Shopify account
2. Configure timer
Configure the Create Message action
1. Connect your Vitally account
2. Select a Organization Id
3. Select a Conversation Id
4. Configure External Id
5. Optional- Configure Timestamp
6. Configure Message
7. Select a From
8. Select one or more To
9. Optional- Select one or more CC
10. Optional- Select one or more BCC
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 Abandoned Cart on Shopify

Description:Emit new event each time a user abandons their cart.

Version:0.0.4

Key:shopify_developer_app-new-abandoned-cart

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 shopify from "../../shopify_developer_app.app.mjs";
import common from "../../../shopify/sources/new-abandoned-cart/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-new-abandoned-cart",
  name: "New Abandoned Cart",
  type: "source",
  description: "Emit new event each time a user abandons their cart.",
  version: "0.0.4",
  dedupe: "unique",
  props: {
    shopify,
    ...common.props,
  },
};

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	`shopify`	`app`	This component uses the Shopify app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`

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 Message on Vitally

Description:Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)

Version:0.0.2

Key:vitally-create-message

View on GitHub

Vitally Overview#

The Vitally API offers a window into customer success operations, enabling you to automate workflows, integrate with other tools, and manipulate customer data programmatically. With Pipedream, you can harness this API to create custom automations that react to events in Vitally, sync data between Vitally and other platforms, or maintain up-to-date customer profiles across your business stack.

Action Code#

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

export default {
  key: "vitally-create-message",
  name: "Create Message",
  version: "0.0.2",
  description: "Create a new message. [See the documentation](https://docs.vitally.io/pushing-data-to-vitally/rest-api/messages#create-a-message-post)",
  type: "action",
  props: {
    vitally,
    organizationId: {
      propDefinition: [
        vitally,
        "organizationId",
      ],
    },
    conversationId: {
      propDefinition: [
        vitally,
        "conversationId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
    },
    externalId: {
      propDefinition: [
        vitally,
        "externalId",
      ],
      description: "The unique ID of the message in your system.",
    },
    timestamp: {
      type: "string",
      label: "Timestamp",
      description: "The ISO-formatted string timestamp of when the message was sent.",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The HTML content of the message.",
    },
    from: {
      propDefinition: [
        vitally,
        "assignedToId",
        ({ organizationId }) => ({
          organizationId,
        }),
      ],
      label: "From",
      description: "The sender participant.",
    },
    to: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "To",
      description: "List of the recipient participants.",
    },
    cc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "CC",
      description: "List of the cc recipient participants.",
      optional: true,
    },
    bcc: {
      propDefinition: [
        vitally,
        "assignedToId",
      ],
      type: "string[]",
      label: "BCC",
      description: "List of the bcc recipient participants.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      vitally,
      organizationId,
      conversationId,
      from,
      to,
      cc,
      bcc,
      ...data
    } = this;

    const response = await vitally.createMessage({
      $,
      organizationId,
      conversationId,
      data: {
        ...data,
        from: {
          type: "user",
          id: from,
        },
        to: to && to.map((id) => ({
          type: "user",
          id,
        })),
        cc: cc && cc.map((id) => ({
          type: "user",
          id,
        })),
        bcc: bcc && bcc.map((id) => ({
          type: "user",
          id,
        })),
      },
    });

    $.export("$summary", `A new message with Id: ${response.id} was successfully created!`);
    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
Vitally	`vitally`	`app`	This component uses the Vitally app.
Organization Id	`organizationId`	`string`	Select a value from the drop down menu.
Conversation Id	`conversationId`	`string`	Select a value from the drop down menu.
External Id	`externalId`	`string`	The unique ID of the message in your system.
Timestamp	`timestamp`	`string`	The ISO-formatted string timestamp of when the message was sent.
Message	`message`	`string`	The HTML content of the message.
From	`from`	`string`	Select a value from the drop down menu.
To	`to`	`string[]`	Select a value from the drop down menu.
CC	`cc`	`string[]`	Select a value from the drop down menu.
BCC	`bcc`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To retrieve your API Key,

Click the drop down on the top left with Vitally logo
Go to “Settings” > “Integrations” > Vitally REST API
Copy the API Key under Secret Token

Create Message with Vitally API on New Abandoned Cart from Shopify API

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