Add or Update Contact with Yespo API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

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 + Pipedream#

Other Popular Integrations#

Generate Event with Yespo API on New Scheduled Tasks from Pipedream API

Pipedream + Yespo

Add or Update Contact with Yespo API on New Scheduled Tasks from Pipedream API

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