Add or Update Contact with Yespo API on New Event Emitted (Instant) from Shopify API

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

Trigger workflow on

New Event Emitted (Instant) from the Shopify API

Next, do this

Add or Update Contact with the Yespo 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 Yespo 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 Add or Update Contact action
1. Connect your Yespo account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Configure Channels
5. Optional- Configure Region
6. Optional- Configure Town
7. Optional- Configure Address
8. Optional- Configure Postcode
9. Optional- Configure Additional Fields
10. Optional- Configure Address Book Id
11. Optional- Select a Contact Id
12. Optional- Configure External Customer Id
13. Optional- Configure Contact Key
14. Optional- Configure Language Code
15. Optional- Configure TimeZone
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#

Add or Update Contact on Yespo

Description:Adds a new contact or updates an existing one. [See the documentation](https://docs.yespo.io/reference/addcontact-1)

Version:0.0.1

Key:yespo-add-update-contact

View on GitHub

Yespo Overview#

The Yespo API offers a platform for personalized customer engagement through multichannel marketing automation. By integrating Yespo with Pipedream, you can create custom workflows that trigger based on customer interactions or data changes. This allows for dynamic campaign management, customer segmentation, and real-time analytics, enabling you to automate and scale personalized marketing efforts efficiently.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import yespo from "../../yespo.app.mjs";

export default {
  key: "yespo-add-update-contact",
  name: "Add or Update Contact",
  description: "Adds a new contact or updates an existing one. [See the documentation](https://docs.yespo.io/reference/addcontact-1)",
  version: "0.0.1",
  type: "action",
  props: {
    yespo,
    firstName: {
      type: "string",
      label: "First Name",
      description: "Contact's first name.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Contact's last name.",
      optional: true,
    },
    channels: {
      type: "string[]",
      label: "Channels",
      description: "Channels for the contact. For example: `[ { \"device\": { \"appId\": \"83b77a49-fc28-409b-aeaa-68c9d544ab9d\", \"deviceModel\": \"iPhone\", \"os\": \"iOS\", \"locale\": \"en_UK\", \"clientVersion\": \"native\", \"appVersion\": \"1.23.45\", \"active\": true }, \"type\": \"email\", \"value\": \"pipedream@test.com\" } ]`. [See the documentation to further information](https://docs.yespo.io/reference/addcontact-1)",
    },
    addressRegion: {
      type: "string",
      label: "Region",
      description: "The address region.",
      optional: true,
    },
    addressTown: {
      type: "string",
      label: "Town",
      description: "The address city.",
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "The address line.",
      optional: true,
    },
    addressPostcode: {
      type: "string",
      label: "Postcode",
      description: "Postal/ZIP code.",
      optional: true,
    },
    additionalFields: {
      type: "object",
      label: "Additional Fields",
      description: "Values of the additional fields for a contact. Keys are additional field ID.",
      optional: true,
    },
    addressBookId: {
      type: "string",
      label: "Address Book Id",
      description: "The address book unique identifier.",
      optional: true,
    },
    contactId: {
      propDefinition: [
        yespo,
        "contactId",
      ],
      optional: true,
    },
    externalCustomerId: {
      type: "string",
      label: "External Customer Id",
      description: "External contact id.",
      optional: true,
    },
    contactKey: {
      type: "string",
      label: "Contact Key",
      description: "Contact's key.",
      optional: true,
    },
    languageCode: {
      type: "string",
      label: "Language Code",
      description: "Language code for the contact.",
      optional: true,
    },
    timeZone: {
      type: "string",
      label: "TimeZone",
      description: "The contact's time zone. See [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
      optional: true,
    },
  },
  async run({ $ }) {
    const fields = [];
    if (this.additionalFields) {
      for (const [
        key,
        value,
      ] of Object.entries(this.additionalFields)) {
        fields.push({
          [key]: value,
        });
      }
    }

    const data = {
      firstName: this.firstName,
      lastName: this.lastName,
      channels: this.channels && parseObject(this.channels),
      address: {
        region: this.addressRegion,
        town: this.addressTown,
        address: this.address,
        postcode: this.addressPostcode,
      },
      addressBookId: this.addressBookId,
      contactId: this.contactId,
      externalCustomerId: this.externalCustomerId,
      contactKey: this.contactKey,
      languageCode: this.languageCode,
      timeZone: this.timeZone,
      fields,
    };

    const response = await this.yespo.addOrUpdateContact({
      $,
      data,
    });
    $.export("$summary", `Successfully added or updated the contact with Id: ${response.id}`);
    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
Yespo	`yespo`	`app`	This component uses the Yespo app.
First Name	`firstName`	`string`	Contact's first name.
Last Name	`lastName`	`string`	Contact's last name.
Channels	`channels`	`string[]`	Channels for the contact. For example: `[ { "device": { "appId": "83b77a49-fc28-409b-aeaa-68c9d544ab9d", "deviceModel": "iPhone", "os": "iOS", "locale": "en_UK", "clientVersion": "native", "appVersion": "1.23.45", "active": true }, "type": "email", "value": "pipedream@test.com" } ]`. See the documentation to further information
Region	`addressRegion`	`string`	The address region.
Town	`addressTown`	`string`	The address city.
Address	`address`	`string`	The address line.
Postcode	`addressPostcode`	`string`	Postal/ZIP code.
Additional Fields	`additionalFields`	`object`	Values of the additional fields for a contact. Keys are additional field ID.
Address Book Id	`addressBookId`	`string`	The address book unique identifier.
Contact Id	`contactId`	`string`	Select a value from the drop down menu.
External Customer Id	`externalCustomerId`	`string`	External contact id.
Contact Key	`contactKey`	`string`	Contact's key.
Language Code	`languageCode`	`string`	Language code for the contact.
TimeZone	`timeZone`	`string`	The contact's time zone. See TZ database name.

Action Authentication#

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

About Yespo#

Yespo is a Marketing Automation Service made to embody the toughest ideas of enterprise level solutions in very clear and efficient way for everyone.

More Ways to Connect Yespo + Shopify#

Other Popular Integrations#

Add or Update Contact with Yespo API on New Article from Shopify Developer App API

Shopify + Yespo

Add or Update Contact with Yespo API on New Event Emitted (Instant) from Shopify API

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