← Mailwizz

Create Campaign with Mailwizz API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Campaign with the Mailwizz API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Campaign with the Mailwizz API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Campaign with Mailwizz API on New Requests from HTTP / Webhook API
HTTP / Webhook + Mailwizz
 
Try it
Create Campaign with Mailwizz API on New Submission from Typeform API
Typeform + Mailwizz
 
Try it
Create Campaign with Mailwizz API on New Submission (Instant) from Jotform API
Jotform + Mailwizz
 
Try it
Create Campaign with Mailwizz API on New Custom Webhook Events from Stripe API
Stripe + Mailwizz
 
Try it
Create Campaign with Mailwizz API on New Scheduled Tasks from Pipedream API
Pipedream + Mailwizz
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
LabelPropTypeDescription
MailwizzmailwizzappThis component uses the Mailwizz app.
Namenamestring

Campaign name.

TypetypestringSelect a value from the drop down menu:autoresponderregular
From NamefromNamestring

The campaign from name.

From EmailfromEmailstring

The campaign from email address.

Subjectsubjectstring

The campaign subject.

To NametoNamestring

The subscriber for which we record the bounce.

Reply ToreplyTostring

RThe camapaign reply to email address.

Send AtsendAtstring

This will use the timezone which customer selected.

List UIDlistIdstringSelect a value from the drop down menu.
Segment UIDsegmentIdstringSelect a value from the drop down menu.
Template UIDtemplateIdstringSelect a value from the drop down menu.
Inline CSSinlineCSSboolean

Accept inline css

Plain TextplainTextstring

Do not send to autogenerate as default.

Auto Plain TextautoPlainTextboolean

Generate plain text template.

URL TrackingurlTrackingboolean

Enable/Disable url tracking.

JSON FeedjsonFeedboolean

Enable/Disable JSON feed.

XML FeedxmlFeedboolean

Enable/Disable XML feed.

Plain Text EmailplainTextEmailboolean

Enable/Disable the plain text email.

Email StatsemailStatsstring

A valid email address where the stats will be sent.

Autoresponder EventautoresponderEventstringSelect a value from the drop down menu:AFTER-SUBSCRIBEAFTER-CAMPAIGN-OPEN
Autoresponder Time UnitautoresponderTimeUnitstringSelect a value from the drop down menu:minutehourdayweekmonthyear
Autoresponder Time ValueautoresponderTimeValueinteger

The unit time value.

Autoresponder Open Campaign IdautoresponderOpenCampaignIdstringSelect a value from the drop down menu.
Cron Jobcronjobstring

If this campaign is advanced recurring, you can set a cron job style frequency.

Cron Job EnabledcronjobEnabledboolean

Enable/Disable cron job frequency.

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 Use Mailwizz

Triggers

New Email Sent from the Mailwizz API

Emit new event when an email campaign is successfully sent.

 
Try it
New Subscriber Added from the Mailwizz API

Emit new event when a new subscriber is created.

 
Try it

Actions

Add Subscriber with the Mailwizz API

Create a new subscriber to a list. See the docs here

 
Try it
Updaste Subscriber with the Mailwizz API

Update a specific subscriber. See the docs here

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Snowflake
Snowflake
A data warehouse built for the cloud
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.