Send SMS with Textlocal API on New Inbound SES Emails from AWS API

Pipedream makes it easy to connect APIs for Textlocal, AWS and 2,900+ other apps remarkably fast.

Trigger workflow on

New Inbound SES Emails from the AWS API

Next, do this

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

Select this integration
Configure the New Inbound SES Emails trigger
1. Connect your AWS account
2. Select a AWS Region
3. Select a SES Domain
Configure the Send SMS action
1. Connect your Textlocal account
2. Configure Sender
3. Configure Message
4. Optional- Configure Numbers
5. Optional- Select a Group Id
6. Optional- Configure Simple Reply
7. Optional- Configure Schedule Time
8. Optional- Configure Receipt URL
9. Optional- Configure Custom
10. Optional- Configure Optouts
11. Optional- Configure Validity
12. Optional- Configure Unicode
13. Optional- Configure Tracking Links
14. Configure Test
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 Inbound SES Emails on AWS

Description:The source subscribes to all emails delivered to a specific domain configured in AWS SES. When an email is sent to any address at the domain, this event source emits that email as a formatted event. These events can trigger a Pipedream workflow and can be consumed via SSE or REST API.

Version:1.2.6

Key:aws-new-emails-sent-to-ses-catch-all-domain

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import { v4 as uuid } from "uuid";
import base from "../common/ses.mjs";
import commonS3 from "../../common/common-s3.mjs";
import { toSingleLineString } from "../../common/utils.mjs";
import { simpleParser } from "mailparser";

export default {
  ...base,
  key: "aws-new-emails-sent-to-ses-catch-all-domain",
  name: "New Inbound SES Emails",
  description: toSingleLineString(`
    The source subscribes to all emails delivered to a
    specific domain configured in AWS SES.
    When an email is sent to any address at the domain,
    this event source emits that email as a formatted event.
    These events can trigger a Pipedream workflow and can be consumed via SSE or REST API.
  `),
  type: "source",
  version: "1.2.6",
  props: {
    ...base.props,
    domain: {
      label: "SES Domain",
      description: "The domain you'd like to configure a catch-all handler for",
      type: "string",
      async options() {
        const { Identities: identities } = await this.listIdentities();
        return identities;
      },
    },
  },
  methods: {
    ...base.methods,
    ...commonS3.methods,
    getReceiptRule(bucketName, topicArn) {
      const name = `pd-catchall-${uuid()}`;
      const rule = {
        Name: name,
        Enabled: true,
        Actions: [
          {
            S3Action: {
              TopicArn: topicArn,
              BucketName: bucketName,
            },
          },
        ],
        Recipients: [
          this.domain,
        ],
        ScanEnabled: true,
      };
      return {
        name,
        rule,
      };
    },
    async processEvent(event) {
      const { body } = event;
      const { Message: rawMessage } = body;
      if (!rawMessage) {
        console.log("No message present, exiting");
        return;
      }

      const { "x-amz-sns-message-id": id } = event.headers;
      const { Timestamp: ts } = event.body;
      const meta = {
        id,
        ts,
      };

      try {
        const message = JSON.parse(rawMessage);
        const {
          bucketName: Bucket,
          objectKey: Key,
        } = message.receipt.action;

        const { Body } = await this.getObject({
          Bucket,
          Key,
        });
        const parsed = await simpleParser(Body);
        for (const attachment of parsed.attachments || []) {
          if (!attachment.content) continue;
          attachment.content_b64 = attachment.content.toString("base64");
          delete attachment.content;
        }

        // Emit to the default channel
        this.$emit(parsed, {
          id,
          summary: parsed.subject,
          ts,
        });

        // and a channel specific to the email address
        const address = parsed.to?.[0]?.address;
        if (address) {
          this.$emit(parsed, {
            id,
            name: address,
            summary: parsed.subject,
            ts,
          });
        }
      } catch (err) {
        console.log(
          `Couldn't parse message. Emitting raw message. Error: ${err}`,
        );
        this.$emit({
          rawMessage,
        }, {
          ...meta,
          summary: "Couldn't parse message",
        });
      }
    },
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
AWS Region	`region`	`string`	Select a value from the drop down menu.
SES Domain	`domain`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Send SMS on Textlocal

Description:This Action can be used to send text messages to either individual numbers or entire contact groups. [See the docs here](https://api.txtlocal.com/docs/sendsms) Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.

Version:0.0.2

Key:textlocal-send-sms

View on GitHub

Textlocal Overview#

The Textlocal API on Pipedream allows for robust SMS messaging capabilities within workflows. You can send notifications, alerts, and updates directly to mobile users, automate marketing campaigns, or integrate SMS into multi-channel communication strategies. By leveraging Pipedream's serverless platform, you can create complex workflows involving Textlocal for various application domains without managing infrastructure, boosting productivity and engagement through the power of automated text messaging.

Action Code#

import textlocal from "../../textlocal.app.mjs";

export default {
  key: "textlocal-send-sms",
  name: "Send SMS",
  description:
    `This Action can be used to send text messages to either individual numbers or entire contact groups. [See the docs here](https://api.txtlocal.com/docs/sendsms)
    Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.`,
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    textlocal,
    sender: {
      propDefinition: [
        textlocal,
        "sender",
      ],
    },
    message: {
      propDefinition: [
        textlocal,
        "message",
      ],
    },
    numbers: {
      propDefinition: [
        textlocal,
        "numbers",
      ],
      description: "Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.",
      optional: true,
    },
    groupId: {
      propDefinition: [
        textlocal,
        "groupId",
      ],
      description: "Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.",
      optional: true,
    },
    simpleReply: {
      propDefinition: [
        textlocal,
        "simpleReply",
      ],
      optional: true,
    },
    scheduleTime: {
      propDefinition: [
        textlocal,
        "scheduleTime",
      ],
      optional: true,
    },
    receiptUrl: {
      propDefinition: [
        textlocal,
        "receiptUrl",
      ],
      optional: true,
    },
    custom: {
      propDefinition: [
        textlocal,
        "custom",
      ],
      optional: true,
    },
    optouts: {
      propDefinition: [
        textlocal,
        "optouts",
      ],
      optional: true,
    },
    validity: {
      propDefinition: [
        textlocal,
        "validity",
      ],
      optional: true,
    },
    unicode: {
      propDefinition: [
        textlocal,
        "unicode",
      ],
      optional: true,
    },
    trackingLinks: {
      propDefinition: [
        textlocal,
        "trackingLinks",
      ],
      optional: true,
    },
    test: {
      propDefinition: [
        textlocal,
        "test",
      ],
    },
  },
  async run({ $ }) {
    const params = {
      numbers: this.numbers,
      sender: this.sender,
      message: this.message,
      groupId: this.groupId,
      simple_reply: this.simpleReply,
      schedule_time: this.scheduleTime,
      receipt_url: this.receiptUrl,
      custom: this.custom,
      optouts: this.optouts,
      validity: this.validity,
      unicode: this.unicode,
      tracking_links: this.trackingLinks,
      test: this.test,
    };
    const response = await this.textlocal.sendSMS({
      $,
      params,
    });
    $.export("$summary", "Successfully sent SMS");
    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
Textlocal	`textlocal`	`app`	This component uses the Textlocal app.
Sender	`sender`	`string`	Use this field to specify the sender name for your message. This must be at least 3 characters in length but no longer than 11 alphanumeric characters or 13 numeric characters. If this is excluded it will use the default sender name configured on your account
Message	`message`	`string`	The message content. This parameter should be no longer than 765 characters. See Helpful Information for message length details. The message also must be URL Encoded to support symbols like &.
Numbers	`numbers`	`string`	Note: While both numbers and group_id are optional parameters, one or the other must be included in the request for the message to be sent.
Group Id	`groupId`	`integer`	Select a value from the drop down menu.
Simple Reply	`simpleReply`	`boolean`	Set to true to enable the Simple Reply Service for the message. This will override any sender value, as a Simple Reply Service number will be used instead.
Schedule Time	`scheduleTime`	`string`	This parameter can be used to specify a schedule date/time for your message, which should be provided in Unix timestamp format. Times should be provided in GMT.
Receipt URL	`receiptUrl`	`string`	Use this field to specify an alternative URL to which the delivery receipt(s) will be sent. See handling receipts documentation.
Custom	`custom`	`string`	This value will be set against the message batch and will passed back in the delivery receipts. This allows you to match delivery receipts to their corresponding messages.
Optouts	`optouts`	`boolean`	Can be set to true in order to check against your own opt-outs list and Textlocal's global opt-outs database. Your message will not be sent to numbers within these lists. If not provided defaults to false.
Validity	`validity`	`string`	Can be set, up to 72 hours in advance, to say after which time, you don't want the message delivered. This should be in a Unix timestamp format.
Unicode	`unicode`	`boolean`	Set this value to true to specify that your message body will contain unicode characters. See Encoding/Decoding Unicode Documentation
Tracking Links	`trackingLinks`	`boolean`	Set this value to true to specify that the message contains links and they should be converted to short links (trackable in messenger), Please note that links must be url encoded before being placed into the message
Test	`test`	`boolean`	Set this field to true to enable test mode, no messages will be sent and your credit balance will be unaffected. If not provided defaults to false

Action Authentication#

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

Get your api key in your settings > API keys

About Textlocal#

Bulk SMS Marketing Service for Business | Send ...

More Ways to Connect Textlocal + AWS#

Other Popular Integrations#

Create Contact with Textlocal API on New Inbound SES Emails from AWS API

AWS + Textlocal

Send SMS with Textlocal API on New Inbound SES Emails from AWS API

Pipedream makes it easy to connect APIs for Textlocal, AWS and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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