Create Email Message with Selzy API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Email Message with the Selzy 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 Selzy 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 Email Message action
1. Connect your Selzy account
2. Configure Sender's name
3. Configure Sender's email address
4. Configure Subject
5. Configure Body
6. Select a List ID
7. Optional- Configure Text Body
8. Configure Generate Text
9. Optional- Configure Raw Body
10. Optional- Select a Message Format
11. Optional- Configure Lang
12. Optional- Select a Template Id
13. Optional- Select a System Template Id
14. Optional- Select a Wrap Type
15. Optional- Configure Categories
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 Email Message on Selzy

Description:Adds a new email message. [See the documentation](https://selzy.com/en/support/category/api/messages/)

Version:0.0.1

Key:selzy-create-email-message

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  MESSAGE_FORMAT_OPTIONS, WRAP_TYPE_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import selzy from "../../selzy.app.mjs";

export default {
  key: "selzy-create-email-message",
  name: "Create Email Message",
  description: "Adds a new email message. [See the documentation](https://selzy.com/en/support/category/api/messages/)",
  version: "0.0.1",
  type: "action",
  props: {
    selzy,
    senderName: {
      type: "string",
      label: "Sender's name",
      description: "It is a string that does not match the email address (the sender_email argument).",
    },
    senderEmail: {
      type: "string",
      label: "Sender's email address",
      description: "This email must be checked (to do this, you need to manually create at least one email with this return address via the web interface, then click on the \"send the confirmation request\" link and follow the link from the email).",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "String with the letter subject. It may include substitution fields. If you wish to use substitution fields, specify a string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ \"Welcome to Our Newsletter, \\{\\{Name\\}\\}!\" }}`. The parameter is optional if Template Id is indicated.",
    },
    body: {
      type: "string",
      label: "Body",
      description: "HTML body of the letter. It may include substitution fields. If you wish to use substitution fields, specify an HTML string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ \"<p>Hello \\{\\{Name\\}\\},</p><p>Here is your update.</p>\" }}`.",
    },
    listId: {
      propDefinition: [
        selzy,
        "listId",
      ],
    },
    textBody: {
      type: "string",
      label: "Text Body",
      description: "Text body of the letter. It may include substitution fields. If you wish to use substitution fields, specify a text string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ \"Hello \\{\\{Name\\}\\},\\nHere is your update.\" }}`.",
      optional: true,
    },
    generateText: {
      type: "boolean",
      label: "Generate Text",
      description: "`True` means that the text part of the letter will be generated automatically based on the HTML part. If you do not provide the text version along with the HTML version, you are recommended to set the **Generate Text** parameter to `true` for automatic generation of the text part of the letter. If the text variant of the letter is provided using the **Text Body** parameter, the **Generate Text** parameter is ignored. Thus, if the **Generate Text** value has been set to `true`, the server's response will contain a warning.",
    },
    rawBody: {
      type: "string",
      label: "Raw Body",
      description: "It is intended to save the json structure of the block editor data structure (if the value is **Message Format** = block) The parameter obtains only the JSON structure, otherwise it will not be transferred.",
      optional: true,
    },
    messageFormat: {
      type: "string",
      label: "Message Format",
      description: `It defines the manner of creating a letter.
        \n 1 - If you transfer the \`text\` value in this parameter and both the body and **Text Body** parameters are filled, the body parameter will be ignored, and the letter will be created from the data, transferred in the **Text Body** parameter.
        \n 2 - If you transfer the \`block\` value in this parameter but do not specify **Raw Body**, the letter will be saved as **Raw HTML**.
        \n 3 - If you transfer the \`block\` value in this parameter, the **body** and **Raw Body** parameters must be transferred so taht you can save the message in the block editor format.`,
      options: MESSAGE_FORMAT_OPTIONS,
      optional: true,
    },
    lang: {
      type: "string",
      label: "Lang",
      description: `Two-letter language code for the string with the unsubscribe link that is added to each letter automatically.
        If it is not specified, the language code from the API URL is used.
        In addition to the string with the unsubscribe link, this language also affects the interface of the unsubscribe page. Languages en, it, ua and ru are fully supported, and in case of some other languages (da, de, es, fr, nl, pl, pt, tr), the string with a link will be translated, and the control interface will be in English.`,
      optional: true,
    },
    templateId: {
      propDefinition: [
        selzy,
        "templateId",
      ],
      optional: true,
    },
    systemTemplateId: {
      propDefinition: [
        selzy,
        "systemTemplateId",
      ],
      optional: true,
    },
    wrapType: {
      type: "string",
      label: "Wrap Type",
      description: "Alignment of the message text on the specified side. If the argument is missing, the text will not be aligned.",
      options: WRAP_TYPE_OPTIONS,
      optional: true,
    },
    categories: {
      type: "string[]",
      label: "Categories",
      description: "A list of letter categories.",
      optional: true,
    },
  },
  async run({ $ }) {
    if (this.templateId && this.systemTemplateId) {
      throw new ConfigurationError("You can only use one of the Template Id or System Template Id parameters.");
    }
    const response = await this.selzy.createEmailMessage({
      $,
      params: {
        sender_name: this.senderName,
        sender_email: this.senderEmail,
        subject: this.subject,
        body: this.body,
        list_id: this.listId,

        text_body: this.textBody,
        generate_text: +this.generateText,
        raw_body: this.rawBody,
        message_format: this.messageFormat,
        lang: this.lang,
        template_id: this.templateId,
        system_template_id: this.systemTemplateId,
        wrap_type: this.wrapType,
        categories: parseObject(this.categories)?.join(","),
      },
    });

    if (response.error) throw new ConfigurationError(response.error);

    $.export("$summary", `Email message created successfully with ID ${response.result.message_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
Selzy	`selzy`	`app`	This component uses the Selzy app.
Sender's name	`senderName`	`string`	It is a string that does not match the email address (the sender_email argument).
Sender's email address	`senderEmail`	`string`	This email must be checked (to do this, you need to manually create at least one email with this return address via the web interface, then click on the "send the confirmation request" link and follow the link from the email).
Subject	`subject`	`string`	String with the letter subject. It may include substitution fields. If you wish to use substitution fields, specify a string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ "Welcome to Our Newsletter, \{\{Name\}\}!" }}`. The parameter is optional if Template Id is indicated.
Body	`body`	`string`	HTML body of the letter. It may include substitution fields. If you wish to use substitution fields, specify an HTML string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ "<p>Hello \{\{Name\}\},</p><p>Here is your update.</p>" }}`.
List ID	`listId`	`string`	Select a value from the drop down menu.
Text Body	`textBody`	`string`	Text body of the letter. It may include substitution fields. If you wish to use substitution fields, specify a text string within a Pipedream Custom Expression and escape the curly brackets with a backslash. For example: `{{ "Hello \{\{Name\}\},\nHere is your update." }}`.
Generate Text	`generateText`	`boolean`	`True` means that the text part of the letter will be generated automatically based on the HTML part. If you do not provide the text version along with the HTML version, you are recommended to set the Generate Text parameter to `true` for automatic generation of the text part of the letter. If the text variant of the letter is provided using the Text Body parameter, the Generate Text parameter is ignored. Thus, if the Generate Text value has been set to `true`, the server's response will contain a warning.
Raw Body	`rawBody`	`string`	It is intended to save the json structure of the block editor data structure (if the value is Message Format = block) The parameter obtains only the JSON structure, otherwise it will not be transferred.
Message Format	`messageFormat`	`string`	Select a value from the drop down menu:`{ "label": "Raw HTML", "value": "raw_html" }{ "label": "Block", "value": "block" }{ "label": "Text", "value": "text" }`
Lang	`lang`	`string`	Two-letter language code for the string with the unsubscribe link that is added to each letter automatically. If it is not specified, the language code from the API URL is used. In addition to the string with the unsubscribe link, this language also affects the interface of the unsubscribe page. Languages en, it, ua and ru are fully supported, and in case of some other languages (da, de, es, fr, nl, pl, pt, tr), the string with a link will be translated, and the control interface will be in English.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
System Template Id	`systemTemplateId`	`string`	Select a value from the drop down menu.
Wrap Type	`wrapType`	`string`	Select a value from the drop down menu:`{ "label": "Skip (Do not apply)", "value": "skip" }{ "label": "Right (Right alignment)", "value": "right" }{ "label": "Left (Left alignment)", "value": "left" }{ "label": "Center (Center alignment)", "value": "center" }`
Categories	`categories`	`string[]`	A list of letter categories.

Action Authentication#

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

About Selzy#

Email Marketing Platform

More Ways to Connect Selzy + Pipedream#

Other Popular Integrations#

Create Campaign with Selzy API on New Scheduled Tasks from Pipedream API

Pipedream + Selzy

Create Email Message with Selzy API on New Scheduled Tasks from Pipedream API

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

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

Developers ♥ Pipedream

1-24of2,700+apps by most popular

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