← Slack

Send a Custom Message with Slack API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Send a Custom Message with the Slack API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Send a Custom Message with the Slack API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Send a Custom Message action
    1. Connect your Slack account
    2. Select a Channel
    3. Configure Text
    4. Optional- Configure attachments
    5. Optional- Configure unfurl_links
    6. Optional- Configure unfurl_media
    7. Optional- Configure parse
    8. Optional- Configure Send as User
    9. Optional- Configure Bot Username
    10. Optional- Configure Icon (emoji)
    11. Optional- Configure Icon (image URL)
    12. Optional- Configure mrkdwn
    13. Optional- Configure blocks
    14. Optional- Configure link_names
    15. Optional- Configure reply_broadcast
    16. Optional- Configure Thread Timestamp
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

Send a Custom Message on Slack
Description:Customize advanced setttings and send a message to a channel, group or user
Version:0.1.0
Key:slack-send-custom-message

Code

const slack = require("../../slack.app.js");

module.exports = {
  key: "slack-send-custom-message",
  name: "Send a Custom Message",
  description: "Customize advanced setttings and send a message to a channel, group or user",
  version: "0.1.0",
  type: "action",
  props: {
    slack,
    conversation: {
      propDefinition: [
        slack,
        "conversation",
      ],
    },
    text: {
      propDefinition: [
        slack,
        "text",
      ],
    },
    attachments: {
      propDefinition: [
        slack,
        "attachments",
      ],
    },
    unfurl_links: {
      propDefinition: [
        slack,
        "unfurl_links",
      ],
    },
    unfurl_media: {
      propDefinition: [
        slack,
        "unfurl_media",
      ],
    },
    parse: {
      propDefinition: [
        slack,
        "parse",
      ],
    },
    as_user: {
      propDefinition: [
        slack,
        "as_user",
      ],
    },
    username: {
      propDefinition: [
        slack,
        "username",
      ],
    },
    icon_emoji: {
      propDefinition: [
        slack,
        "icon_emoji",
      ],
    },
    icon_url: {
      propDefinition: [
        slack,
        "icon_url",
      ],
    },
    mrkdwn: {
      propDefinition: [
        slack,
        "mrkdwn",
      ],
    },
    blocks: {
      propDefinition: [
        slack,
        "blocks",
      ],
    },
    link_names: {
      propDefinition: [
        slack,
        "link_names",
      ],
    },
    reply_broadcast: {
      propDefinition: [
        slack,
        "reply_broadcast",
      ],
    },
    thread_ts: {
      propDefinition: [
        slack,
        "thread_ts",
      ],
    },
  },
  async run() {
    return await this.slack.sdk().chat.postMessage({
      text: this.text,
      channel: this.conversation,
      attachments: this.attachments,
      unfurl_links: this.unfurl_links,
      unfurl_media: this.unfurl_media,
      parse: this.parse,
      as_user: this.as_user,
      username: this.username,
      icon_emoji: this.icon_emoji,
      icon_url: this.icon_url,
      mrkdwn: this.mrkdwn,
      blocks: this.blocks,
      link_names: this.link_names,
      reply_broadcast: this.reply_broadcast,
      thread_ts: this.thread_ts,
    });
  },
};

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.
LabelPropTypeDescription
SlackslackappThis component uses the Slack app.
ChannelconversationstringSelect a value from the drop down menu.
Texttextstring

Text of the message to send (see Slack's formatting docs). This field is usually required, unless you're providing only attachments instead. Provide no more than 40,000 characters or risk truncation.

attachmentsstring

A JSON-based array of structured attachments, presented as a URL-encoded string (e.g., [{"pretext": "pre-hello", "text": "text-world"}]).

unfurl_linksboolean

TRUE by default. Pass FALSE to disable unfurling of links.

unfurl_mediaboolean

TRUE by default. Pass FALSE to disable unfurling of media content.

parsestring

Change how messages are treated. Defaults to none. See below.

Send as Useras_userboolean

Optionally pass TRUE to post the message as the authed user, instead of as a bot. Defaults to FALSE.

Bot Usernameusernamestring

Optionally customize your bot's user name (default is Pipedream). Must be used in conjunction with as_user set to false, otherwise ignored.

Icon (emoji)icon_emojistring

Optionally provide an emoji to use as the icon for this message. E.g., :fire: Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored.

Icon (image URL)icon_urlstring

Optionally provide an image URL to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored.

mrkdwnboolean

TRUE by default. Pass FALSE to disable Slack markup parsing.

blocksstring

Enter an array of structured blocks as a URL-encoded string. E.g., [{ "type": "section", "text": { "type": "mrkdwn", "text": "This is a mrkdwn section block :ghost: *this is bold*, and ~this is crossed out~, and <https://pipedream.com|this is a link>" }}]

Tip: Construct your blocks in a code step, return them as an array, and then pass the return value to this step.

link_namesstring

Find and link channel names and usernames.

reply_broadcaststring

Used in conjunction with thread_ts and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to false.

Thread Timestampthread_tsstring

Provide another message's ts value to make this message a reply (e.g., if triggering on new Slack messages, enter {{event.ts}}). Avoid using a reply's ts value; use its parent instead.

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:

calls:readcalls:writechannels:historychannels:readchannels:writednd:readdnd:writeemoji:readfiles:readgroups:historygroups:readgroups:writeim:historyim:readim:writelinks:readlinks:writempim:historympim:readmpim:writepins:readpins:writereactions:readreactions:writereminders:readreminders:writeremote_files:readremote_files:sharestars:readstars:writeteam:readusergroups:readusergroups:writeusers:readusers:read.emailusers:writechat:write:botchat:write:usercommandsfiles:write:userusers.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.

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.