Create Campaign with listmonk API on New Command Received (Instant) from Discord API

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

Trigger workflow on

New Command Received (Instant) from the Discord API

Next, do this

Create Campaign with the listmonk 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 Discord trigger and listmonk action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Command Received (Instant) trigger
1. Connect your Discord account
2. Configure Channels
3. Configure discordApphook
4. Configure Commands
Configure the Create Campaign action
1. Connect your listmonk account
2. Configure Campaign Name
3. Configure Subject
4. Select one or more Lists
5. Select a Type
6. Select a Content Type
7. Configure Body
8. Optional- Configure From Email
9. Optional- Configure Tags
10. Optional- Configure Send At
11. Optional- Select a Template
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 Command Received (Instant) on Discord

Description:Emit new event for each command posted to one or more channels in a Discord server

Version:0.0.3

Key:discord-new-command-received

View on GitHub

Discord Overview#

The Discord API interacts seamlessly with Pipedream, empowering you to craft customized automations and workflows for your Discord server. With this powerful integration, you can automate tasks like message posting, user management, and notifications, based on a myriad of triggers and actions from different apps. These automations can enhance the Discord experience for community moderators and members, by synchronizing with external tools, organizing community engagement, and streamlining notifications.

Trigger Code#

import discord from "../../discord.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  type: "source",
  key: "discord-new-command-received",
  name: "New Command Received (Instant)",
  description: "Emit new event for each command posted to one or more channels in a Discord server",
  version: "0.0.3",
  dedupe: "unique",
  props: {
    discord,
    channels: {
      type: "$.discord.channel[]",
      appProp: "discord",
      label: "Channels",
      description: "Select the channel(s) you'd like to be notified for",
    },
    // eslint-disable-next-line pipedream/props-label,pipedream/props-description
    discordApphook: {
      type: "$.interface.apphook",
      appProp: "discord",
      async eventNames() {
        return this.channels || [];
      },
    },
    commands: {
      label: "Commands",
      description: "List of commands to listen. E.g. `[\"/hi\", \"/hello\"]`",
      type: "string[]",
    },
  },
  async run(event) {
    if (event.guildID != this.discord.$auth.guild_id) {
      return;
    }

    const command = event.content.split(" ")[0];

    if (typeof this.commands === "string") {
      this.commands = JSON.parse(this.commands);
    }

    if (!this.commands.includes(command)) {
      return;
    }

    this.$emit(event, {
      id: event.id,
      summary: `New command posted with ID ${event.id}`,
      ts: Date.parse(event.createdTimestamp),
    });
  },
  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
Discord	`discord`	`app`	This component uses the Discord app.
Channels	`channels`	`$.discord.channel[]`	Select the channel(s) you'd like to be notified for
	`discordApphook`	`$.interface.apphook`
Commands	`commands`	`string[]`	List of commands to listen. E.g. `["/hi", "/hello"]`

Trigger Authentication#

Discord uses OAuth authentication. When you connect your Discord account, Pipedream will open a popup window where you can sign into Discord and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Discord API.

Pipedream requests the following authorization scopes when you connect your account:

botemailidentifyguilds

About Discord#

Use this app to create a Discord source that emits messages from your guild to a Pipedream workflow.

Action#

Create Campaign on listmonk

Description:Creates a new campaign in Listmonk. [See the documentation](https://listmonk.app/docs/apis/campaigns/#post-apicampaigns)

Version:0.0.1

Key:listmonk-create-campaign

View on GitHub

listmonk Overview#

The listmonk API enables you to interact programmatically with the listmonk platform, which specializes in managing mailing lists and sending out newsletters. Using this API, you can automate subscriber management, campaign dispatching, and performance tracking. When you integrate listmonk with Pipedream, you can create powerful workflows that react to events from other apps, process data, and use that data to trigger actions within listmonk.

Action Code#

import listmonk from "../../listmonk.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "listmonk-create-campaign",
  name: "Create Campaign",
  description: "Creates a new campaign in Listmonk. [See the documentation](https://listmonk.app/docs/apis/campaigns/#post-apicampaigns)",
  version: "0.0.1",
  type: "action",
  props: {
    listmonk,
    name: {
      type: "string",
      label: "Campaign Name",
      description: "The name of the campaign to create.",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject of the campaign.",
    },
    listIds: {
      propDefinition: [
        listmonk,
        "listIds",
      ],
    },
    type: {
      type: "string",
      label: "Type",
      description: "The type of the campaign.",
      options: constants.CAMPAIGN_TYPE_OPTIONS,
    },
    contentType: {
      type: "string",
      label: "Content Type",
      description: "The content type of the campaign.",
      options: constants.CONTENT_TYPE_OPTIONS,
    },
    body: {
      type: "string",
      label: "Body",
      description: "The body of the campaign.",
    },
    fromEmail: {
      type: "string",
      label: "From Email",
      description: "From e-mail to show on the campaign e-mails. If left empty, the default value from settings is used.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Array of string tags to mark the campaign.",
      optional: true,
    },
    sendAt: {
      type: "string",
      label: "Send At",
      description: "A timestamp to schedule the campaign at. Eg: 2021-12-25T06:00:00 (YYYY-MM-DDTHH:MM:SS)",
      optional: true,
    },
    templateId: {
      propDefinition: [
        listmonk,
        "templateId",
      ],
    },
  },
  async run({ $ }) {
    const { data } = await this.listmonk.createCampaign({
      data: {
        name: this.name,
        subject: this.subject,
        lists: this.listIds,
        from_email: this.fromEmail,
        type: this.type,
        content_type: this.contentType,
        body: this.body,
        tags: this.tags,
        send_at: this.sendAt,
        template_id: this.templateId,
      },
      $,
    });

    if (data?.id) {
      $.export("$summary", `Successfully created campaign with ID ${data.id}.`);
    }

    return data;
  },
};

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
listmonk	`listmonk`	`app`	This component uses the listmonk app.
Campaign Name	`name`	`string`	The name of the campaign to create.
Subject	`subject`	`string`	The subject of the campaign.
Lists	`listIds`	`string[]`	Select a value from the drop down menu.
Type	`type`	`string`	Select a value from the drop down menu:`regularoptin`
Content Type	`contentType`	`string`	Select a value from the drop down menu:`richtexthtmlmarkdownplain`
Body	`body`	`string`	The body of the campaign.
From Email	`fromEmail`	`string`	From e-mail to show on the campaign e-mails. If left empty, the default value from settings is used.
Tags	`tags`	`string[]`	Array of string tags to mark the campaign.
Send At	`sendAt`	`string`	A timestamp to schedule the campaign at. Eg: 2021-12-25T06:00:00 (YYYY-MM-DDTHH:MM:SS)
Template	`templateId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

Please enter your listmonk admin username and password below. For more info, refer to listmonk’s documentation.

Pipedream recommends using a strong and unique password for your listmonk account.

Create Campaign with listmonk API on New Command Received (Instant) from Discord API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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