Create Draft Campaign with Sendy API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Draft Campaign with the Sendy 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 Sendy 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 Create Draft Campaign action
1. Connect your Sendy account
2. Configure From Name
3. Configure From Email
4. Configure Reply To
5. Configure Title
6. Configure Subject
7. Optional- Configure Plain Text
8. Configure HTML Text
9. Select a Brand ID
10. Optional- Select one or more List IDs
11. Optional- Configure Segment IDs
12. Optional- Select one or more Exclude List IDs
13. Optional- Configure Exclude Segment IDs
14. Optional- Configure Query String
15. Select a Track Opens
16. Select a Track Clicks
17. Optional- Configure Schedule Date Time
18. Optional- Configure Schedule 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#

Create Draft Campaign on Sendy

Description:Creates a new draft campaign ready to be filled in with details. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#create-send-campaigns)

Version:0.0.1

Key:sendy-create-draft-campaign

View on GitHub

Sendy Overview#

The Sendy API allows you to programmatically manage email campaigns, subscribers, and lists. With Pipedream's capabilities, you can leverage Sendy API to create custom workflows that respond to events, synchronize data across platforms, and automate email marketing tasks. Pipedream provides a serverless platform where you can connect Sendy with hundreds of other apps without writing complex code, harnessing the power of Sendy's features with event-driven programming and API integration.

Action Code#

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

export default {
  key: "sendy-create-draft-campaign",
  name: "Create Draft Campaign",
  description: "Creates a new draft campaign ready to be filled in with details. [See the documentation](https://sendy.co/api?app_path=https://sendy.email/dev2#create-send-campaigns)",
  version: "0.0.1",
  type: "action",
  props: {
    sendy,
    fromName: {
      type: "string",
      label: "From Name",
      description: "The 'From Name' of your campaign.",
    },
    fromEmail: {
      type: "string",
      label: "From Email",
      description: "The 'From Email' of your campaign.",
    },
    replyTo: {
      type: "string",
      label: "Reply To",
      description: "The 'Reply To' of your campaign.",
    },
    title: {
      type: "string",
      label: "Title",
      description: "The 'Title' of your campaign.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The 'Subject' of your campaign.",
    },
    plainText: {
      type: "string",
      label: "Plain Text",
      description: "The 'Plain text version' of your campaign.",
      optional: true,
    },
    htmlText: {
      type: "string",
      label: "HTML Text",
      description: "The 'HTML version' of your campaign.",
    },
    brandId: {
      propDefinition: [
        sendy,
        "brandId",
      ],
    },
    listIds: {
      propDefinition: [
        sendy,
        "listId",
        ({ brandId }) => ({
          brandId,
        }),
      ],
      type: "string[]",
      label: "List IDs",
      description: "A list of List IDs.",
      optional: true,
    },
    segmentIds: {
      type: "string[]",
      label: "Segment IDs",
      description: "A list of segment IDs. Segment ids can be found in the segments setup page.",
      optional: true,
    },
    excludeListIds: {
      propDefinition: [
        sendy,
        "listId",
        ({ brandId }) => ({
          brandId,
        }),
      ],
      type: "string[]",
      label: "Exclude List IDs",
      description: "Lists to exclude from your campaign.",
      optional: true,
    },
    excludeSegmentIds: {
      type: "string[]",
      label: "Exclude Segment IDs",
      description: "Segments to exclude from your campaign. Segment ids can be found in the segments setup page.",
      optional: true,
    },
    queryString: {
      type: "string",
      label: "Query String",
      description: "e.g., Google Analytics tags.",
      optional: true,
    },
    trackOpens: {
      type: "string",
      label: "Track Opens",
      description: "Open tracking behaviour.",
      options: [
        {
          label: "Disabled",
          value: "0",
        },
        {
          label: "Enabled",
          value: "1",
        },
        {
          label: "Anonymous",
          value: "2",
        },
      ],
    },
    trackClicks: {
      type: "string",
      label: "Track Clicks",
      description: "Click tracking behaviour.",
      options: [
        {
          label: "Disabled",
          value: "0",
        },
        {
          label: "Enabled",
          value: "1",
        },
        {
          label: "Anonymous",
          value: "2",
        },
      ],
    },
    scheduleDateTime: {
      type: "string",
      label: "Schedule Date Time",
      description: "Format: June 15, 2021 6:05pm. Minutes in increments of '5', eg. 6pm, 6:05pm, 6:10pm, 6:15pm..",
      optional: true,
    },
    scheduleTimezone: {
      type: "string",
      label: "Schedule Timezone",
      description: "e.g., 'America/New_York'. See the [list of PHP's supported timezones](https://www.php.net/manual/en/timezones.php). This parameter only applies if you're scheduling your campaign with 'Schedule Date Time' parameter. Sendy will use your default timezone if this parameter is empty.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.sendy.createDraftCampaign({
      $,
      data: {
        from_name: this.fromName,
        from_email: this.fromEmail,
        reply_to: this.replyTo,
        title: this.title,
        subject: this.subject,
        plain_text: this.plainText,
        html_text: this.htmlText,
        list_ids: this.listIds && parseObject(this.listIds),
        segment_ids: this.segmentIds && parseObject(this.segmentIds),
        exclude_list_ids: this.excludeListIds && parseObject(this.excludeListIds),
        exclude_segment_ids: this.excludeSegmentIds && parseObject(this.excludeSegmentIds),
        brand_id: this.brandId,
        query_string: this.queryString,
        track_opens: this.trackOpens,
        track_clicks: this.trackClicks,
        schedule_date_time: this.scheduleDateTime,
        schedule_timezone: this.scheduleTimezone,
      },
    });

    $.export("$summary", "Draft campaign created successfully");
    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
Sendy	`sendy`	`app`	This component uses the Sendy app.
From Name	`fromName`	`string`	The 'From Name' of your campaign.
From Email	`fromEmail`	`string`	The 'From Email' of your campaign.
Reply To	`replyTo`	`string`	The 'Reply To' of your campaign.
Title	`title`	`string`	The 'Title' of your campaign.
Subject	`subject`	`string`	The 'Subject' of your campaign.
Plain Text	`plainText`	`string`	The 'Plain text version' of your campaign.
HTML Text	`htmlText`	`string`	The 'HTML version' of your campaign.
Brand ID	`brandId`	`string`	Select a value from the drop down menu.
List IDs	`listIds`	`string[]`	Select a value from the drop down menu.
Segment IDs	`segmentIds`	`string[]`	A list of segment IDs. Segment ids can be found in the segments setup page.
Exclude List IDs	`excludeListIds`	`string[]`	Select a value from the drop down menu.
Exclude Segment IDs	`excludeSegmentIds`	`string[]`	Segments to exclude from your campaign. Segment ids can be found in the segments setup page.
Query String	`queryString`	`string`	e.g., Google Analytics tags.
Track Opens	`trackOpens`	`string`	Select a value from the drop down menu:`{ "label": "Disabled", "value": "0" }{ "label": "Enabled", "value": "1" }{ "label": "Anonymous", "value": "2" }`
Track Clicks	`trackClicks`	`string`	Select a value from the drop down menu:`{ "label": "Disabled", "value": "0" }{ "label": "Enabled", "value": "1" }{ "label": "Anonymous", "value": "2" }`
Schedule Date Time	`scheduleDateTime`	`string`	Format: June 15, 2021 6:05pm. Minutes in increments of '5', eg. 6pm, 6:05pm, 6:10pm, 6:15pm..
Schedule Timezone	`scheduleTimezone`	`string`	e.g., 'America/New_York'. See the list of PHP's supported timezones. This parameter only applies if you're scheduling your campaign with 'Schedule Date Time' parameter. Sendy will use your default timezone if this parameter is empty.

Action Authentication#

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

About Sendy#

Sendy is a self hosted newsletter app that lets you send newsletters 100x cheaper via Amazon SES.

More Ways to Connect Sendy + Pipedream#

Other Popular Integrations#

Add or Update a Subscriber with Sendy API on New Scheduled Tasks from Pipedream API

Pipedream + Sendy

Try it

Unsubscribe Email with Sendy API on New Scheduled Tasks from Pipedream API

Pipedream + Sendy

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

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

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it