This is reference content about building functions and workflows. Learn more if you're not yet familiar with this new Slack platform paradigm.

send_ephemeral_message

Send an ephemeral message (one that only the recipient can see)

Facts

Schema ID

Schema.slack.functions.SendEphemeralMessage

Schema reference

slack#/functions/send_ephemeral_message

Required scopes

chat:write

Input parameters

Required parameters

user_id

Schema.slack.types.usergroup_id

·Required

The ID of the user to show the ephemeral message to

U111AAA111

channel_id

Schema.slack.types.channel_id

·Required

The conversation ID for the channel you are sending the message to

C123456
D123ABC456

message

Schema.slack.types.rich_text

·Required

The textual message to send to ephemerally (previously accepted as text)

Optional parameters

thread_ts

Schema.types.string

·Optional

The ts identifier of an existing message to send this message to as a reply.

1355517523.000005

Output parameters

Required parameters

message_ts

Schema.types.string

·Required

The channel-specific unique identifier for this message, also serves as a confirmation that the message was sent.

Usage guide

Sends an ephemeral message to a specific channel. This lets a user see what your workflow has to say without everyone in the conversation having to see it or it becoming part of the conversation's record.

Example workflow step

const sendEphemeralMessageStep = ExampleWorkflow.addStep(
  Schema.slack.functions.SendEphemeralMessage,
  {
    channel_id: "C082T4F6S1N",
    user_id: "U0J46F228L0",
    message: "Someone in this conversation is not accurately representing reality. Converse further with care.",
  },
);