Create Contact with Endorsal API on New Order Event (Instant) from WooCommerce API

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

Trigger workflow on

New Order Event (Instant) from the WooCommerce API

Next, do this

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

Select this integration
Configure the New Order Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
Configure the Create Contact action
1. Connect your Endorsal account
2. Select a Campaign ID
3. Optional- Configure Name
4. Optional- Configure Email
5. Optional- Configure Phone
6. Optional- Configure Avatar
7. Optional- Configure Location
8. Optional- Configure Position
9. Optional- Configure Company
10. Optional- Configure Website
11. Optional- Configure External ID
12. Optional- Configure Imported From
13. Optional- Configure Custom Attributes
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 Order Event (Instant) on WooCommerce

Description:Emit new event each time the specified order event(s) occur

Version:0.0.4

Key:woocommerce-new-order-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "woocommerce-new-order-event",
  name: "New Order Event (Instant)",
  description: "Emit new event each time the specified order event(s) occur",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listOrders({
        per_page: perPage,
        orderby: "date",
      });
    },
    getTopic(topicType) {
      return `order.${topicType}`;
    },
    generateMeta(eventType, {
      id, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Order ID: ${id} ${eventType}`,
        ts,
      };
    },
  },
  sampleEmit,
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce 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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

Action#

Create Contact on Endorsal

Description:Creates a new contact for requesting testimonials. [See the documentation](https://developers.endorsal.io/docs/endorsal/b3a6mtczmzu5na-create-a-new-contact)

Version:0.0.1

Key:endorsal-create-contact

View on GitHub

Endorsal Overview#

The Endorsal API provides a way to programmatically manage and showcase customer testimonials. With Pipedream, you can automate the collection and display of endorsements, sync these testimonials with other marketing tools, and trigger actions based on new reviews. This seamless integration enables you to leverage customer feedback effectively to boost your brand's credibility and visibility.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObj } from "../../common/utils.mjs";
import endorsal from "../../endorsal.app.mjs";

export default {
  key: "endorsal-create-contact",
  name: "Create Contact",
  description: "Creates a new contact for requesting testimonials. [See the documentation](https://developers.endorsal.io/docs/endorsal/b3a6mtczmzu5na-create-a-new-contact)",
  version: "0.0.1",
  type: "action",
  props: {
    endorsal,
    campaignID: {
      propDefinition: [
        endorsal,
        "campaignID",
      ],
    },
    name: {
      propDefinition: [
        endorsal,
        "name",
      ],
      optional: true,
    },
    email: {
      propDefinition: [
        endorsal,
        "email",
      ],
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "The phone of the contact. `Email` OR `Phone` is required.",
      optional: true,
    },
    avatar: {
      propDefinition: [
        endorsal,
        "avatar",
      ],
      optional: true,
    },
    location: {
      propDefinition: [
        endorsal,
        "location",
      ],
      optional: true,
    },
    position: {
      propDefinition: [
        endorsal,
        "position",
      ],
      optional: true,
    },
    company: {
      propDefinition: [
        endorsal,
        "company",
      ],
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "The website of the contact.",
      optional: true,
    },
    externalID: {
      type: "string",
      label: "External ID",
      description: "ID from platform from which contact was imported.",
      optional: true,
    },
    importedFrom: {
      type: "string",
      label: "Imported From",
      description: "Name of platform from which contact was imported.",
      optional: true,
    },
    customAttributes: {
      type: "object",
      label: "Custom Attributes",
      description: "Custom key/value pairs.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      endorsal,
      campaignID,
      email,
      phone,
      customAttributes,
      ...data
    } = this;

    if (!email && !phone) {
      throw new ConfigurationError("You must provide either **Email** or **Phone**.");
    }

    const response = await endorsal.createContact({
      params: {
        campaignID,
      },
      data: {
        email,
        phone,
        customAttributes: parseObj(customAttributes),
        ...data,
      },
    });

    $.export("$summary", `Successfully created contact 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
Endorsal	`endorsal`	`app`	This component uses the Endorsal app.
Campaign ID	`campaignID`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the contact.
Email	`email`	`string`	The email of the contact. `Email` OR `Phone` is required.
Phone	`phone`	`string`	The phone of the contact. `Email` OR `Phone` is required.
Avatar	`avatar`	`string`	URL to the image.
Location	`location`	`string`	The location of the contact.
Position	`position`	`string`	The position of the contact in the company.
Company	`company`	`string`	The company of the contact.
Website	`website`	`string`	The website of the contact.
External ID	`externalID`	`string`	ID from platform from which contact was imported.
Imported From	`importedFrom`	`string`	Name of platform from which contact was imported.
Custom Attributes	`customAttributes`	`object`	Custom key/value pairs.

Action Authentication#

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

To retrieve your API keys,

Navigate to your Endorsal account and sign in
Go to “Account Details” > “API”

Create Contact with Endorsal API on New Order Event (Instant) from WooCommerce API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular