POST /chat.postEphemeral

Sends an ephemeral message to a user in a channel.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

token String Yes

Authentication token. Requires scope: chat:write

Request body fields

Name Type Required Description
icon_emoji String No

Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

parse String No

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

username String No

Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below.

channel String Yes

Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

text String No

How this field works and whether it is required depends on other fields you use in your API call. See below for more detail.

as_user Boolean No

Pass true to post the message as the authed user. Defaults to true if the chat:write:bot scope is not included. Otherwise, defaults to false.

attachments String No

A JSON-based array of structured attachments, presented as a URL-encoded string.

user String Yes

id of the user who will receive the ephemeral message. The user should be in the channel specified by the channel argument.

icon_url String No

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

link_names Boolean No

Find and link channel names and usernames.

blocks String No

A JSON-based array of structured blocks, presented as a URL-encoded string.

thread_ts String No

Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.