Send SMS with SMS Everyone API on New Click Activity (Instant) from Mailersend API

Pipedream makes it easy to connect APIs for SMS Everyone, Mailersend and 2,700+ other apps remarkably fast.

Trigger workflow on

New Click Activity (Instant) from the Mailersend API

Next, do this

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

Select this integration
Configure the New Click Activity (Instant) trigger
1. Connect your Mailersend account
2. Select a Domain ID
Configure the Send SMS action
1. Connect your SMS Everyone account
2. Configure Originator
3. Optional- Configure Destinations
4. Configure Message
5. Optional- Configure Time Scheduled
6. Optional- Configure Reference
7. Optional- Select one or more CRM IDs
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 Click Activity (Instant) on Mailersend

Description:Emit new event when the recipient clicks a link in your email. [See the documentation](https://developers.mailersend.com/api/v1/webhooks.html#webhooks-overview)

Version:0.0.1

Key:mailersend-email-has-click-activity

View on GitHub

Mailersend Overview#

The MailerSend API integrates with Pipedream to create powerful email automation workflows, enabling you to send transactional emails, create and manage templates, and track email activities like opens or clicks. With these capabilities, you can automate routine communications, personalize mass mailings based on user actions or data, and gain insights into your email campaign performances, all within the context of a serverless Pipedream workflow.

Trigger Code#

import common from "../common/webhook.mjs";
import { EmailWebhookEventType } from "mailersend";

export default {
  ...common,
  key: "mailersend-email-has-click-activity",
  name: "New Click Activity (Instant)",
  description: "Emit new event when the recipient clicks a link in your email. [See the documentation](https://developers.mailersend.com/api/v1/webhooks.html#webhooks-overview)",
  version: "0.0.1",
  dedupe: "unique",
  type: "source",
  methods: {
    ...common.methods,
    getEvents() {
      return [
        EmailWebhookEventType.CLICKED,
      ];
    },
  },
};

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
Mailersend	`app`	`app`	This component uses the Mailersend app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Domain ID	`domainId`	`string`	Select a value from the drop down menu.
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#

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

API tokens are generated for sending domains and can have different permissions to limit which areas of your account they may be used to access. See docs

About Mailersend#

Transactional email service that delivers

Action#

Send SMS on SMS Everyone

Description:Send an SMS message or a bulk SMS campaign. [See the documentation](https://www.smseveryone.com.au/restapi)

Version:0.0.1

Key:sms_everyone-send-sms

View on GitHub

SMS Everyone Overview#

The SMS Everyone API lets you send SMS messages to users in Australia, offering a platform for automated text message communication. In Pipedream, you can harness this API to create workflows that trigger SMS notifications based on various events. Combine it with other apps and services to tailor unique automation solutions, such as sending alerts, reminders, or marketing messages directly from your Pipedream workflows.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import smsEveryone from "../../sms_everyone.app.mjs";

export default {
  key: "sms_everyone-send-sms",
  name: "Send SMS",
  description: "Send an SMS message or a bulk SMS campaign. [See the documentation](https://www.smseveryone.com.au/restapi)",
  version: "0.0.1",
  type: "action",
  props: {
    smsEveryone,
    originator: {
      type: "string",
      label: "Originator",
      description: "Sender Number. Check the restrictions in your country as to whether you can use a word origin. If you send from a number, use international format without the + sign.",
    },
    destinations: {
      type: "string[]",
      label: "Destinations",
      description: "Phone number/s of the recipient/s. Ideally this should also be sent in international format without the + sign.",
      optional: true,
    },
    message: {
      type: "string",
      label: "Message",
      description: "The message content.",
    },
    timescheduled: {
      type: "string",
      label: "Time Scheduled",
      description: "If you're scheduling a message, include this field. Format: \"YYYYMMDDHHMM\" **If you're sending now, this field is not necessary**. If yuo set the date/time in the past, the SMS will be sent immediately.",
      optional: true,
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "Your unique reference ID of the message.",
      optional: true,
    },
    crmids: {
      propDefinition: [
        smsEveryone,
        "crmids",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.destinations && !this.crmids) {
      throw new ConfigurationError("You must provide at least Destinations or CRM IDs.");
    }
    const response = await this.smsEveryone.sendSMS({
      $,
      data: {
        Originator: this.originator,
        Destinations: parseObject(this.destinations),
        Message: this.message,
        TimeScheduled: this.timescheduled,
        Reference: this.reference,
        Action: "create",
        CrmIds: parseObject(this.crmids),
      },
    });

    if (response.Code) throw new ConfigurationError(response.Message);

    $.export("$summary", `Successfully sent sms with CampaignId: ${response.CampaignId}`);
    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
SMS Everyone	`smsEveryone`	`app`	This component uses the SMS Everyone app.
Originator	`originator`	`string`	Sender Number. Check the restrictions in your country as to whether you can use a word origin. If you send from a number, use international format without the + sign.
Destinations	`destinations`	`string[]`	Phone number/s of the recipient/s. Ideally this should also be sent in international format without the + sign.
Message	`message`	`string`	The message content.
Time Scheduled	`timescheduled`	`string`	If you're scheduling a message, include this field. Format: "YYYYMMDDHHMM" If you're sending now, this field is not necessary. If yuo set the date/time in the past, the SMS will be sent immediately.
Reference	`reference`	`string`	Your unique reference ID of the message.
CRM IDs	`crmids`	`string[]`	Select a value from the drop down menu.