chat.postMessage

This method posts a message to a public channel, private group, or IM channel.

Arguments

This method has the URL https://slack.com/api/chat.postMessage and follows the Slack Web API calling conventions.

Please note that the default value of the as_user parameter varies depending on the kind of token you're using. It's best to be explicit with this value. Read more about Authorship to understand how its default value may vary.

Formatting

Messages are formatted as described in the formatting spec. You can specify values for parse and link_names to change formatting behavior.

The optional attachments argument should contain a JSON-encoded array of attachments. For more information, see the attachments spec.

By default links to media are unfurled, but links to text content are not. For more information on the differences and how to control this, see the the unfurling documentation.

Use the Message Builder to preview your message formatting and attachments in real time! It's easy to translate your JSON examples to the parameters understood by chat.postMessage.

Authorship

How message authorship is attributed varies by a few factors, with some behaviors varying depending on the kinds of tokens you're using to post a message.

The best way to realize your intended result is to be explicit with the as_user parameter.

chat.postMessage wants your message posting to succeed and may attempt to guess the most appropriate as_user interpretation based on the kind of token you're using.

If as_user is not provided at all, then the value is inferred, based on the scopes granted to the caller: If the caller could post with as_user passed as false, then that is how the method behaves; otherwise, the method behaves as if as_user were passed as true.

When as_user is false

When the as_user parameter is set to false, messages are posted as "bot_messages", with message authorship attributed to the default user name and icons associated with the Custom Integration or Slack App.

With as_user set to false, you may also provide a username to explicitly specify the bot user's identity for this message, along with icon_url or icon_emoji.

Effect on identity

Token types provide varying default identity values for username, icon_url, and icon_emoji.

• test tokens
  • generic user icon and "bot" username
• custom bot user token
  • generic bot icon, with generic "bot" username
• Slack App user token with chat:write:bot
  • inherits Slack App's icon, with generic "bot" username (see below)
• Slack App bot user token
  • inherits Slack App's icon, with generic "bot" username (see below)

Note: In the Slack App cases above, it would certainly make more sense for your application's name to be the default username associated with your app. This inconsistent behavior will be corrected. Of course, you can still name your bot "bot," if that is your bot's name.

When as_user is true

Set as_user to true and the authenticated user will appear as the author of the message, ignoring any values provided for username, icon_url, and icon_emoji. Posting as the authenticated user requires the client or the more preferred chat:write:user scopes.

Effect on identity

Token types provide varying default identity values for username, icon_url, and icon_emoji.

• test tokens
  • inherits the icon and username of the token owner
• custom bot user token
  • inherits bot user's specified icon and username
• Slack App user token with chat:write:user
  • inherits icon and username of the token owner
• Slack App bot user token
  • inherits Slack App's icon and app's bot username

Channels

You must specify a public channel, private group, or an IM channel with the channel argument. Each one behaves slightly differently based on the authenticated user's permissions and additional arguments:

Post to a public channel

You can either pass the channel's name (#general) or encoded ID (C024BE91L), and the message will be posted to that channel. The channel's ID can be retrieved through the channels.list API method.

Post to a private group

As long as the authenticated user is a member of the private group, you can either pass the group's name (secret-group) or encoded ID (G012AC86C), and the message will be posted to that group. The private group's ID can be retrieved through the groups.list API method.

Post to an IM channel

Posting to an IM channel is a little more complex depending on the value of as_user.

• If as_user is false:
  • Pass a username (@chris) as the value of channel to post to that user's @slackbot channel as the bot.
  • Pass the IM channel's ID (D023BB3L2) as the value of channel to post to that IM channel as the bot. The IM channel's ID can be retrieved through the im.list API method.
• If as_user is true:
  • Pass the IM channel's ID (D023BB3L2) as the value of channel to post to that IM channel as the authenticated user. The IM channel's ID can be retrieved through the im.list API method.

Response

{
    "ok": true,
    "ts": "1405895017.000506",
    "channel": "C024BE91L",
    "message": {
        ...
    }
}

The response includes the timestamp (ts) and channel for the posted message. It also includes the complete message object, as it was parsed by our servers. This may differ from the provided arguments as our servers sanitize links, attachments and other properties.

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.