Skip to main content

send_ephemeral_message

Facts​

DescriptionSend an ephemeral message (one that only the recipient can see)
SchemaSchema.slack.functions.SendEphemeralMessage
Schema referenceslack#/functions/send_ephemeral_message
Required scopes
chat:write

Input Parameters​

Required Input Parameters

channel_idSchema.slack.types.channel_idRequired

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

Examples
C123456
D123ABC456
messageSchema.slack.types.rich_textRequired

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

user_idSchema.slack.types.usergroup_idRequired

The ID of the user to show the ephemeral message to

Examples
U111AAA111

Optional Input Parameters

thread_tsSchema.types.stringOptional

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

Examples
1355517523.000005

Output Parameters​

Required Output Parameters

message_tsSchema.types.stringRequired

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

Usage info​

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.",
  },
);