Create Campaign with Mailwizz API on New Finished Automation Run from Browserhub API

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

Trigger workflow on

New Finished Automation Run from the Browserhub 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 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Browserhub 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 Finished Automation Run trigger
1. Connect your Browserhub account
2. Configure Polling interval
3. Optional- Select a Scraper ID
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 Finished Automation Run on Browserhub

Description:Emit new event when an automation run has finished running. [See the documentation](https://developer.browserhub.io/)

Version:0.0.1

Key:browserhub-new-finished-automation-run

View on GitHub

Browserhub Overview#

The Browserhub API offers automation and control over browser sessions, enabling users to create, manipulate, and extract data from web pages programmatically. Integrating Browserhub with Pipedream opens a world of possibilities for automating web interaction workflows, monitoring website changes, scraping data, and testing web applications. Pipedream's serverless platform allows for easy orchestration of API calls and data handling, making it a powerful tool for developers to harness the capabilities of Browserhub in a scalable and efficient manner.

Trigger Code#

import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";
import browserhub from "../../browserhub.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "browserhub-new-finished-automation-run",
  name: "New Finished Automation Run",
  description: "Emit new event when an automation run has finished running. [See the documentation](https://developer.browserhub.io/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    browserhub,
    db: "$.service.db",
    timer: {
      label: "Polling interval",
      description: "Pipedream will poll the AskNicely on this schedule",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    scraperId: {
      propDefinition: [
        browserhub,
        "scraperId",
      ],
      optional: true,
    },
  },
  methods: {
    _getBaseDate() {
      return this.db.get("baseDate");
    },
    _setBaseDate(baseDate = null) {
      this.db.set("baseDate", baseDate);
    },
    async startEvent(maxResults = 0) {
      const baseDate = this._getBaseDate();
      let newBaseDate = null;

      const response = this.browserhub.paginate({
        fn: this.browserhub.listRuns,
        maxResults,
        baseDate,
        params: {
          scraper_id: this.scraperId,
        },
      });

      const responseArray = [];

      for await (const item of response) {
        if (item.status === "successful") responseArray.push(item);
        if (item.status === "running") newBaseDate = item.created_at;
      }

      if (newBaseDate) this._setBaseDate(newBaseDate);
      if (!newBaseDate && responseArray.length) this._setBaseDate(responseArray[0].created_at);

      for (const item of responseArray.reverse()) {
        this.$emit(
          item,
          {
            id: item.id,
            summary: `Successfully finished automation run with ID: ${item.id}`,
            ts: item.created_at,
          },
        );
      }
    },
  },
  hooks: {
    async deploy() {
      await this.startEvent(25);
    },
  },
  async run() {
    await this.startEvent();
  },
  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
Browserhub	`browserhub`	`app`	This component uses the Browserhub app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling interval	`timer`	`$.interface.timer`	Pipedream will poll the AskNicely on this schedule
Scraper ID	`scraperId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Browserhub#

Easy to use no-code web scraping and data extraction software.

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