Add Contact with Salesmate API on New Cancelled Order (Instant) from Shopify Developer App API

Pipedream makes it easy to connect APIs for Salesmate, 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 Contact with the Salesmate 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 Salesmate 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 Contact action
1. Connect your Salesmate account
2. Optional- Configure First Name
3. Configure Last Name
4. Select a Owner
5. Optional- Configure Mobile
6. Optional- Select a Company
7. Optional- Configure Email
8. Optional- Configure Website
9. Optional- Configure Google Plus Handle
10. Optional- Configure LinkedIn Handle
11. Optional- Configure Phone
12. Optional- Configure Other Phone
13. Optional- Configure Skype Id
14. Optional- Configure Facebook Handle
15. Optional- Configure Twitter Handle
16. Optional- Select a Currency
17. Optional- Configure Designation
18. Optional- Configure Billing Address Line 1
19. Optional- Configure Billing Address Line 2
20. Optional- Configure Billing City
21. Optional- Configure Billing Zip Code
22. Optional- Configure Billing State
23. Optional- Configure Billing Country
24. Optional- Configure Description
25. Optional- Select one or more Tags
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 Contact on Salesmate

Description:This API is used to add a contact. [See docs here](https://apidocs.salesmate.io/#b768facc-930f-4f93-b9a7-a26a0875b6b0)

Version:0.0.1

Key:salesmate-add-contact

View on GitHub

Salesmate Overview#

The Salesmate API enables automation of CRM-related tasks within the Salesmate platform. By leveraging this API on Pipedream, you can craft serverless workflows that interact with Salesmate data, such as contacts, deals, and activities. This allows for seamless integration of Salesmate with other services to enhance sales processes, enable real-time data updates, and trigger custom actions based on specific events within your CRM.

Action Code#

import { defineAction } from "@pipedream/types";
import salesmate from "../../app/salesmate.app.mjs";
export default defineAction({
    name: "Add Contact",
    version: "0.0.1",
    key: "salesmate-add-contact",
    description: "This API is used to add a contact. [See docs here](https://apidocs.salesmate.io/#b768facc-930f-4f93-b9a7-a26a0875b6b0)",
    type: "action",
    props: {
        salesmate,
        firstName: {
            propDefinition: [
                salesmate,
                "firstName",
            ],
            optional: true,
        },
        lastName: {
            propDefinition: [
                salesmate,
                "lastName",
            ],
        },
        owner: {
            propDefinition: [
                salesmate,
                "owner",
            ],
        },
        mobile: {
            propDefinition: [
                salesmate,
                "mobile",
            ],
            optional: true,
        },
        company: {
            propDefinition: [
                salesmate,
                "company",
            ],
            optional: true,
        },
        email: {
            propDefinition: [
                salesmate,
                "email",
            ],
            optional: true,
        },
        website: {
            propDefinition: [
                salesmate,
                "website",
            ],
            optional: true,
        },
        googlePlusHandle: {
            propDefinition: [
                salesmate,
                "googlePlusHandle",
            ],
            optional: true,
        },
        linkedInHandle: {
            propDefinition: [
                salesmate,
                "linkedInHandle",
            ],
            optional: true,
        },
        phone: {
            propDefinition: [
                salesmate,
                "phone",
            ],
            optional: true,
        },
        otherPhone: {
            propDefinition: [
                salesmate,
                "otherPhone",
            ],
            optional: true,
        },
        skypeId: {
            propDefinition: [
                salesmate,
                "skypeId",
            ],
            optional: true,
        },
        facebookHandle: {
            propDefinition: [
                salesmate,
                "facebookHandle",
            ],
            optional: true,
        },
        twitterHandle: {
            propDefinition: [
                salesmate,
                "twitterHandle",
            ],
            optional: true,
        },
        currency: {
            propDefinition: [
                salesmate,
                "currency",
            ],
            optional: true,
        },
        designation: {
            propDefinition: [
                salesmate,
                "designation",
            ],
            optional: true,
        },
        billingAddressLine1: {
            propDefinition: [
                salesmate,
                "billingAddressLine1",
            ],
            optional: true,
        },
        billingAddressLine2: {
            propDefinition: [
                salesmate,
                "billingAddressLine2",
            ],
            optional: true,
        },
        billingCity: {
            propDefinition: [
                salesmate,
                "billingCity",
            ],
            optional: true,
        },
        billingZipCode: {
            propDefinition: [
                salesmate,
                "billingZipCode",
            ],
            optional: true,
        },
        billingState: {
            propDefinition: [
                salesmate,
                "billingState",
            ],
            optional: true,
        },
        billingCountry: {
            propDefinition: [
                salesmate,
                "billingCountry",
            ],
            optional: true,
        },
        description: {
            propDefinition: [
                salesmate,
                "contactDescription",
            ],
            optional: true,
        },
        tags: {
            propDefinition: [
                salesmate,
                "tags",
            ],
            optional: true,
        },
    },
    async run({ $ }) {
        const { salesmate, ...data } = this;
        data.tags = data.tags?.toString();
        const response = await salesmate.addContact({
            $,
            data,
        });
        $.export("$summary", `Contact successfuly created with id: ${response.Data.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
Salesmate	`salesmate`	`app`	This component uses the Salesmate app.
First Name	`firstName`	`string`	First name of the contact.
Last Name	`lastName`	`string`	Last name of the contact.
Owner	`owner`	`integer`	Select a value from the drop down menu.
Mobile	`mobile`	`string`	Mobile number of the contact.
Company	`company`	`integer`	Select a value from the drop down menu.
Email	`email`	`string`	Email of the contact.
Website	`website`	`string`	Website of the contact.
Google Plus Handle	`googlePlusHandle`	`string`	Contact's Google Plus profile link.
LinkedIn Handle	`linkedInHandle`	`string`	Contact's LinkedIn profile link.
Phone	`phone`	`string`	Phone number 1 of the contact.
Other Phone	`otherPhone`	`string`	Phone number 2 of the contact.
Skype Id	`skypeId`	`string`	Contact's Skype ID.
Facebook Handle	`facebookHandle`	`string`	Contact's Facebook link.
Twitter Handle	`twitterHandle`	`string`	Contact's Twitter link.
Currency	`currency`	`string`	Select a value from the drop down menu.
Designation	`designation`	`string`	Contact's designation.
Billing Address Line 1	`billingAddressLine1`	`string`	Line one of the billing address of the contact.
Billing Address Line 2	`billingAddressLine2`	`string`	Line two of the billing address of the contact.
Billing City	`billingCity`	`string`	City name of contact's address for billing purposes.
Billing Zip Code	`billingZipCode`	`string`	Zip code of the billing City.
Billing State	`billingState`	`string`	State name of contact's address for billing purposes.
Billing Country	`billingCountry`	`string`	Country name of contact's address for billing purposes.
Description	`description`	`string`	Description about the contact. It contains an arbitrary string attached to the contact object.
Tags	`tags`	`string[]`	Select a value from the drop down menu.

Action Authentication#

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

To connect Pipedream to your Salesmate account,

First, retrieve your Access Keys:

Navigate to your Salesmate account and sign in
Click the User dropdown on the top right
Go to “My Account” > “Access Key”

Copy and paste the x-linkname below, which is the hostname from your Salesmate dashboard URL. For example, this might be something like demo.salesmate.io.

Finally, paste the domain (if your Salesmate dashboard is demo.salesmate.io, your domain is demo).