Create Subscriber with listmonk API on New Ticket (Instant) from Helpspace API

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

Trigger workflow on

New Ticket (Instant) from the Helpspace API

Next, do this

Create Subscriber 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 Helpspace 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 Ticket (Instant) trigger
1. Connect your Helpspace account
Configure the Create Subscriber action
1. Connect your listmonk account
2. Configure Email
3. Configure Name
4. Select a Status
5. Optional- Select one or more Lists
6. Optional- Configure Preconfirm Subscription
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 Ticket (Instant) on Helpspace

Description:Emit new event when a new ticket is opened in HelpSpace. Note: Users may only have one active Helpspace webhook at a time. [See the documentation](https://documentation.helpspace.com/article/340/webhook)

Version:0.0.1

Key:helpspace-new-ticket

View on GitHub

Helpspace Overview#

The Helpspace API facilitates seamless integration of customer support functionalities into various platforms. With Pipedream, you can harness this API to automate ticket tracking, customer communication, and support resource management. By connecting Helpspace to other apps, you can streamline support workflows, sync data across services, and even trigger actions based on customer interactions or support metrics.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "helpspace-new-ticket",
  name: "New Ticket (Instant)",
  description: "Emit new event when a new ticket is opened in HelpSpace. Note: Users may only have one active Helpspace webhook at a time. [See the documentation](https://documentation.helpspace.com/article/340/webhook)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getTrigger() {
      const baseTrigger = this.getBaseTrigger();
      return {
        ...baseTrigger,
        ticket: {
          ...baseTrigger.ticket,
          created: true,
        },
      };
    },
    generateMeta(ticket) {
      return {
        id: ticket.id,
        summary: `New Ticket ${ticket.subject}`,
        ts: Date.parse(ticket.created_at),
      };
    },
  },
  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
Helpspace	`helpspace`	`app`	This component uses the Helpspace app.
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.

Trigger Authentication#

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

To retrieve your Client ID and Access Token,

Navigate to your HelpSpace account and sign in
Go to “Settings” > “Access Tokens”

About Helpspace#

Simplify your customer support! Use Helpspace’s shared inbox to organize all incoming customer messages in one place for efficient teamwork.

Action#

Create Subscriber on listmonk

Description:Create a new subscriber in Listmonk. [See the documentation](https://listmonk.app/docs/apis/subscribers/#post-apisubscribers)

Version:0.0.1

Key:listmonk-create-subscriber

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-subscriber",
  name: "Create Subscriber",
  description: "Create a new subscriber in Listmonk. [See the documentation](https://listmonk.app/docs/apis/subscribers/#post-apisubscribers)",
  version: "0.0.1",
  type: "action",
  props: {
    listmonk,
    email: {
      type: "string",
      label: "Email",
      description: "The email of the subscriber to create.",
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the subscriber to create.",
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of the new subscriber.",
      options: constants.STATUS_OPTIONS,
    },
    listIds: {
      propDefinition: [
        listmonk,
        "listIds",
      ],
      optional: true,
    },
    preconfirmSubscription: {
      type: "boolean",
      label: "Preconfirm Subscription",
      description: "If `true`, marks subscription as `confirmed` and no-optin e-mails are sent for double opt-in lists.",
      optional: true,
    },
  },
  async run({ $ }) {
    const { data } = await this.listmonk.createSubscriber({
      data: {
        email: this.email,
        name: this.name,
        status: this.status,
        lists: this.listIds,
        preconfirm_subscriptions: this.preconfirmSubscription,
      },
      $,
    });

    if (data?.id) {
      $.export("$summary", `Successfully created subscriber 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.
Email	`email`	`string`	The email of the subscriber to create.
Name	`name`	`string`	The name of the subscriber to create.
Status	`status`	`string`	Select a value from the drop down menu:`enableddisabledblocklisted`
Lists	`listIds`	`string[]`	Select a value from the drop down menu.
Preconfirm Subscription	`preconfirmSubscription`	`boolean`	If `true`, marks subscription as `confirmed` and no-optin e-mails are sent for double opt-in lists.

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.

About listmonk#

listmonk is a self-hosted, high performance mailing list and newsletter manager. It comes as a standalone binary and the only dependency is a Postgres database.