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

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Create Campaign with the Mailwizz 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 Pipedream trigger and Mailwizz 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 Campaign action
1. Connect your Mailwizz account
2. Configure Name
3. Optional- Select a Type
4. Configure From Name
5. Configure From Email
6. Optional- Configure Subject
7. Configure To Name
8. Configure Reply To
9. Configure Send At
10. Select a List UID
11. Optional- Select a Segment UID
12. Select a Template UID
13. Optional- Configure Inline CSS
14. Optional- Configure Plain Text
15. Optional- Configure Auto Plain Text
16. Optional- Configure URL Tracking
17. Optional- Configure JSON Feed
18. Optional- Configure XML Feed
19. Optional- Configure Plain Text Email
20. Optional- Configure Email Stats
21. Optional- Select a Autoresponder Event
22. Optional- Select a Autoresponder Time Unit
23. Optional- Configure Autoresponder Time Value
24. Optional- Select a Autoresponder Open Campaign Id
25. Optional- Configure Cron Job
26. Optional- Configure Cron Job Enabled
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 Campaign on Mailwizz

Description:Create a new campaign. [See the docs here](https://api-docs.mailwizz.com/?php#create-a-campaign)

Version:0.0.1

Key:mailwizz-create-campaign

View on GitHub

Mailwizz Overview#

Mailwizz offers a potent API that enables automation of email marketing tasks, subscriber management, campaign tracking, and more. Using Pipedream, you can harness this API to create custom workflows that trigger on specific events, process data, or synchronize with other apps. Pipedream's serverless architecture allows you to handle workflows at scale without managing infrastructure.

Action Code#

import { clearObj } from "../../common/utils.mjs";
import mailwizz from "../../mailwizz.app.mjs";

export default {
  key: "mailwizz-create-campaign",
  name: "Create Campaign",
  version: "0.0.1",
  description: "Create a new campaign. [See the docs here](https://api-docs.mailwizz.com/?php#create-a-campaign)",
  type: "action",
  props: {
    mailwizz,
    name: {
      type: "string",
      label: "Name",
      description: "Campaign name.",
    },
    type: {
      type: "string",
      label: "Type",
      description: "Campaign type. Default is regular.",
      options: [
        "autoresponder",
        "regular",
      ],
      optional: true,
    },
    fromName: {
      type: "string",
      label: "From Name",
      description: "The campaign from name.",
    },
    fromEmail: {
      type: "string",
      label: "From Email",
      description: "The campaign from email address.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The campaign subject.",
      optional: true,
    },
    toName: {
      type: "string",
      label: "To Name",
      description: "The subscriber for which we record the bounce.",
    },
    replyTo: {
      type: "string",
      label: "Reply To",
      description: "RThe camapaign reply to email address.",
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "This will use the timezone which customer selected.",
    },
    listId: {
      propDefinition: [
        mailwizz,
        "listId",
      ],
    },
    segmentId: {
      propDefinition: [
        mailwizz,
        "segmentId",
        ( { listId } ) => ( {
          listId,
        } ),
      ],
      optional: true,
    },
    templateId: {
      propDefinition: [
        mailwizz,
        "templateId",
      ],
    },
    inlineCSS: {
      type: "boolean",
      label: "Inline CSS",
      description: "Accept inline css",
      optional: true,
    },
    plainText: {
      type: "string",
      label: "Plain Text",
      description: "Do not send to autogenerate as default.",
      optional: true,
    },
    autoPlainText: {
      type: "boolean",
      label: "Auto Plain Text",
      description: "Generate plain text template.",
      optional: true,
    },
    urlTracking: {
      type: "boolean",
      label: "URL Tracking",
      description: "Enable/Disable url tracking.",
      optional: true,
    },
    jsonFeed: {
      type: "boolean",
      label: "JSON Feed",
      description: "Enable/Disable JSON feed.",
      optional: true,
    },
    xmlFeed: {
      type: "boolean",
      label: "XML Feed",
      description: "Enable/Disable XML feed.",
      optional: true,
    },
    plainTextEmail: {
      type: "boolean",
      label: "Plain Text Email",
      description: "Enable/Disable the plain text email.",
      optional: true,
    },
    emailStats: {
      type: "string",
      label: "Email Stats",
      description: "A valid email address where the stats will be sent.",
      optional: true,
    },
    autoresponderEvent: {
      type: "string",
      label: "Autoresponder Event",
      description: "The event that is sent after subscribe or after opening the campaign.",
      options: [
        "AFTER-SUBSCRIBE",
        "AFTER-CAMPAIGN-OPEN",
      ],
      optional: true,
    },
    autoresponderTimeUnit: {
      type: "string",
      label: "Autoresponder Time Unit",
      description: "The unit that the autoresponder will be based on.",
      options: [
        "minute",
        "hour",
        "day",
        "week",
        "month",
        "year",
      ],
      optional: true,
    },
    autoresponderTimeValue: {
      type: "integer",
      label: "Autoresponder Time Value",
      description: "The unit time value.",
      optional: true,
    },
    autoresponderOpenCampaignId: {
      propDefinition: [
        mailwizz,
        "campaignId",
      ],
      label: "Autoresponder Open Campaign Id",
      description: "Id of the camapign, only if event is AFTER-CAMPAIGN-OPEN.",
      optional: true,
    },
    cronjob: {
      type: "string",
      label: "Cron Job",
      description: "If this campaign is advanced recurring, you can set a cron job style frequency.",
      optional: true,
    },
    cronjobEnabled: {
      type: "boolean",
      label: "Cron Job Enabled",
      description: "Enable/Disable cron job frequency.",
      optional: true,
    },
  },
  async run ( { $ } ) {
    const {
      mailwizz,
      fromName,
      fromEmail,
      toName,
      replyTo,
      sendAt,
      listId,
      segmentId,
      templateId,
      inlineCSS,
      plainText,
      autoPlainText,
      urlTracking,
      jsonFeed,
      xmlFeed,
      plainTextEmail,
      emailStats,
      autoresponderEvent,
      autoresponderTimeUnit,
      autoresponderTimeValue,
      autoresponderOpenCampaignId,
      cronjobEnabled,
      ...data
    } = this;

    const response = await mailwizz.createCampaign( clearObj( {
      data: {
        campaign: {
          ...data,
          from_name: fromName,
          from_email: fromEmail,
          to_name: toName,
          reply_to: replyTo,
          send_at: sendAt,
          list_uid: listId,
          segment_uid: segmentId,
          template: {
            template_uid: templateId,
            inline_css: inlineCSS,
            plain_text: plainText,
            auto_plain_text: autoPlainText,
          },
          options: {
            url_tracking: urlTracking || "no",
            json_feed: jsonFeed,
            xml_feed: xmlFeed,
            plain_text_email: plainTextEmail,
            email_stats: emailStats,
            autoresponder_event: autoresponderEvent,
            autoresponder_time_unit: autoresponderTimeUnit,
            autoresponder_time_value: autoresponderTimeValue,
            autoresponder_open_campaign_id: autoresponderOpenCampaignId,
            cronjob_enabled: cronjobEnabled,
          },
        },
      },
    } ) );

    $.export( "$summary", `Campaign with id ${response.campaign_uid} was successfully created!` );
    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
Mailwizz	`mailwizz`	`app`	This component uses the Mailwizz app.
Name	`name`	`string`	Campaign name.
Type	`type`	`string`	Select a value from the drop down menu:`autoresponderregular`
From Name	`fromName`	`string`	The campaign from name.
From Email	`fromEmail`	`string`	The campaign from email address.
Subject	`subject`	`string`	The campaign subject.
To Name	`toName`	`string`	The subscriber for which we record the bounce.
Reply To	`replyTo`	`string`	RThe camapaign reply to email address.
Send At	`sendAt`	`string`	This will use the timezone which customer selected.
List UID	`listId`	`string`	Select a value from the drop down menu.
Segment UID	`segmentId`	`string`	Select a value from the drop down menu.
Template UID	`templateId`	`string`	Select a value from the drop down menu.
Inline CSS	`inlineCSS`	`boolean`	Accept inline css
Plain Text	`plainText`	`string`	Do not send to autogenerate as default.
Auto Plain Text	`autoPlainText`	`boolean`	Generate plain text template.
URL Tracking	`urlTracking`	`boolean`	Enable/Disable url tracking.
JSON Feed	`jsonFeed`	`boolean`	Enable/Disable JSON feed.
XML Feed	`xmlFeed`	`boolean`	Enable/Disable XML feed.
Plain Text Email	`plainTextEmail`	`boolean`	Enable/Disable the plain text email.
Email Stats	`emailStats`	`string`	A valid email address where the stats will be sent.
Autoresponder Event	`autoresponderEvent`	`string`	Select a value from the drop down menu:`AFTER-SUBSCRIBEAFTER-CAMPAIGN-OPEN`
Autoresponder Time Unit	`autoresponderTimeUnit`	`string`	Select a value from the drop down menu:`minutehourdayweekmonthyear`
Autoresponder Time Value	`autoresponderTimeValue`	`integer`	The unit time value.
Autoresponder Open Campaign Id	`autoresponderOpenCampaignId`	`string`	Select a value from the drop down menu.
Cron Job	`cronjob`	`string`	If this campaign is advanced recurring, you can set a cron job style frequency.
Cron Job Enabled	`cronjobEnabled`	`boolean`	Enable/Disable cron job frequency.

Action Authentication#

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

To retrieve your API Key,

Navigate to your Mailwizz account and sign in
Click the option with the Star icon in the left navigation menu
Go to “API Keys”

The URL field below is your Mailwizz host domain.

For example, if you have a Mailwizz instance hosted at https://example.com, then enter example.com in the url field below.

Please note that if the MailWizz hosted website doesn't have clean urls enabled, make sure your url has the index.php part of url included, i.e:
example.com/api/index.php

About Mailwizz#

Full-featured self-hosted email marketing software.

More Ways to Connect Mailwizz + Pipedream#

Other Popular Integrations#

Add Subscriber with Mailwizz API on New Scheduled Tasks from Pipedream API

Pipedream + Mailwizz

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

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

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

Developers ♥ Pipedream

1-24of2,000+apps by most popular

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