Send Announcement with Textline API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Textline, Slack and 2,500+ other apps remarkably fast.

Trigger workflow on

New Message In Channels (Instant) from the Slack API

Next, do this

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

Select this integration
Configure the New Message In Channels (Instant) trigger
1. Connect your Slack account
2. Optional- Select one or more Channels
3. Configure slackApphook
4. Optional- Configure Resolve Names
5. Optional- Configure Ignore Bots
6. Optional- Configure Ignore replies in threads
Configure the Send Announcement action
1. Connect your Textline account
2. Select a Mass Text Group UUID
3. Configure Mass Text Comment Body
4. Configure Mass Text Title
5. Select a Selection Type
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 Message In Channels (Instant) on Slack

Description:Emit new event when a new message is posted to one or more channels

Version:1.0.23

Key:slack-new-message-in-channels

View on GitHub

Slack Overview#

The Pipedream Slack app enables you to build event-driven workflows that interact with the Slack API. Once you authorize the Pipedream app's access to your workspace, you can use Pipedream workflows to perform common Slack actions or write your own code against the Slack API.

The Pipedream Slack app is not a typical app. You don't interact with it directly as a bot, and it doesn't add custom functionality to your workspace out of the box. It makes it easier to automate anything you'd typically use the Slack API for, using Pipedream workflows.

Automate posting updates to your team channels
Create a bot to answer common questions
Integrate with your existing tools and services
And much more!

Trigger Code#

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

export default {
  ...common,
  key: "slack-new-message-in-channels",
  name: "New Message In Channels (Instant)",
  version: "1.0.23",
  description: "Emit new event when a new message is posted to one or more channels",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    conversations: {
      propDefinition: [
        common.props.slack,
        "conversation",
      ],
      type: "string[]",
      label: "Channels",
      description: "Select one or more channels to monitor for new messages.",
      optional: true,
    },
    // eslint-disable-next-line pipedream/props-description,pipedream/props-label
    slackApphook: {
      type: "$.interface.apphook",
      appProp: "slack",
      async eventNames() {
        return this.conversations || [
          "message",
        ];
      },
    },
    resolveNames: {
      propDefinition: [
        common.props.slack,
        "resolveNames",
      ],
    },
    ignoreBot: {
      propDefinition: [
        common.props.slack,
        "ignoreBot",
      ],
    },
    ignoreThreads: {
      type: "boolean",
      label: "Ignore replies in threads",
      description: "Ignore replies to messages in threads",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    getSummary() {
      return "New message in channel";
    },
    async processEvent(event) {
      if (event.type !== "message") {
        console.log(`Ignoring event with unexpected type "${event.type}"`);
        return;
      }
      if (event.subtype && !constants.ALLOWED_MESSAGE_IN_CHANNEL_SUBTYPES.includes(event.subtype)) {
        // This source is designed to just emit an event for each new message received.
        // Due to inconsistencies with the shape of message_changed and message_deleted
        // events, we are ignoring them for now. If you want to handle these types of
        // events, feel free to change this code!!
        console.log("Ignoring message with subtype.");
        return;
      }
      if ((this.ignoreBot) && (event.subtype == "bot_message" || event.bot_id)) {
        return;
      }
      // There is no thread message type only the thread_ts field
      // indicates if the message is part of a thread in the event.
      if (this.ignoreThreads && event.thread_ts) {
        console.log("Ignoring reply in thread");
        return;
      }
      if (this.resolveNames) {
        if (event.user) {
          event.user_id = event.user;
          event.user = await this.getUserName(event.user);
        } else if (event.bot_id) {
          event.bot = await this.getBotName(event.bot_id);
        }
        event.channel_id = event.channel;
        event.channel = await this.getConversationName(event.channel);
        if (event.team) {
          event.team_id = event.team;
          event.team = await this.getTeamName(event.team);
        }
      }
      return event;
    },
  },
  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
Slack	`slack`	`app`	This component uses the Slack app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Channels	`conversations`	`string[]`	Select a value from the drop down menu.
	`slackApphook`	`$.interface.apphook`
Resolve Names	`resolveNames`	`boolean`	Instead of returning `channel`, `team`, and `user` as IDs, return their human-readable names.
Ignore Bots	`ignoreBot`	`boolean`	Ignore messages from bots
Ignore replies in threads	`ignoreThreads`	`boolean`	Ignore replies to messages in threads

Trigger Authentication#

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

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

channels:historychannels:readchannels:writeemoji:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writereactions:readreactions:writereminders:readreminders:writestars:readteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:userfiles:write:usercommandsusers.profile:writeusers.profile:read

About 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.

Action#

Send Announcement on Textline

Description:Send an announcement to a group of contacts. [See the documentation](https://textline.docs.apiary.io/#reference/messaging-tools/announcements/send-an-announcement).

Version:0.0.1

Key:textline-send-announcement

View on GitHub

Action Code#

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

export default {
  key: "textline-send-announcement",
  name: "Send Announcement",
  description: "Send an announcement to a group of contacts. [See the documentation](https://textline.docs.apiary.io/#reference/messaging-tools/announcements/send-an-announcement).",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    massTextGroupUuid: {
      label: "Mass Text Group UUID",
      description: "The UUID of the mass text group.",
      propDefinition: [
        app,
        "groupUuid",
      ],
    },
    massTextCommentBody: {
      type: "string",
      label: "Mass Text Comment Body",
      description: "The content of the message to send.",
    },
    massTextTitle: {
      type: "string",
      label: "Mass Text Title",
      description: "The title of the message.",
    },
    selectionType: {
      type: "string",
      label: "Selection Type",
      description: "The type of the selection for the announcement.",
      reloadProps: true,
      options: Object.values(constants.SELECTION_TYPE),
    },
  },
  additionalProps() {
    const { selectionType } = this;

    if (selectionType === constants.SELECTION_TYPE.TAGS.value) {
      return {
        tag: {
          type: "string",
          label: "Tag",
          description: "Send to all contacts with this tag.",
        },
      };
    }

    if (selectionType === constants.SELECTION_TYPE.PHONE_NUMBERS.value) {
      return {
        phoneNumbers: {
          type: "string[]",
          label: "Phone Numbers",
          description: "The phone numbers to send the announcement to.",
          useQuery: true,
          options: async ({
            page, query,
          }) => {
            const { customers } = await this.app.listCustomers({
              params: {
                page,
                page_size: 30,
                query: query || "",
              },
            });
            return customers.map(({
              name: label, phone_number: value,
            }) => ({
              label,
              value,
            }));
          },
        },
      };
    }

    return {};
  },
  methods: {
    sendAnnouncement(args = {}) {
      return this.app.post({
        path: "/announcements",
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      sendAnnouncement,
      selectionType,
      massTextGroupUuid,
      massTextCommentBody,
      massTextTitle,
      tag,
      phoneNumbers,
    } = this;

    const response = await sendAnnouncement({
      $,
      data: {
        selection_type: selectionType,
        recipients: {
          tag,
          phone_numbers: phoneNumbers,
        },
        mass_text: {
          group_uuid: massTextGroupUuid,
          comment_body: massTextCommentBody,
          title: massTextTitle,
        },
      },
    });

    $.export("$summary", "Successfully sent the announcement.");
    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
Textline	`app`	`app`	This component uses the Textline app.
Mass Text Group UUID	`massTextGroupUuid`	`string`	Select a value from the drop down menu.
Mass Text Comment Body	`massTextCommentBody`	`string`	The content of the message to send.
Mass Text Title	`massTextTitle`	`string`	The title of the message.
Selection Type	`selectionType`	`string`	Select a value from the drop down menu:`{ "label": "Tags", "value": "tags" }{ "label": "Phone Numbers", "value": "phone_numbers" }`

Send Announcement with Textline API on New Message In Channels (Instant) from Slack API

Pipedream makes it easy to connect APIs for Textline, Slack and 2,500+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,500+apps by most popular

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