Send message with the Slack API
Posts a message as the app's bot and returns it with channel and ts, the pair Update message and Delete message ask for. Send text, markdown_text or blocks. The app must be a member of the channel: call Join conversation first for a public one.
- Identifier
- slack_send_message
The request
POST https://connect.reportei.com/api/tools/slack_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"channel": "<channel_id>",
"text": "Hello! This is an example message."
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Illustrative example. Replace the tokens, connection UUID and destination values with your own. This page does not execute the request.
Before executing
- This example uses text. You can also use blocks or markdown_text; do not combine markdown_text with text or blocks. With blocks, include text as an accessibility and notification fallback.
- Connect the workspace using an OAuth app with permission to send and access the conversation. The app must be a member of private channels; public channels also depend on granted permissions.
- Check ok in the response body, not only the HTTP status. Errors such as no_text, missing_scope and not_in_channel require changes to content, scopes or channel access.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| channel | string | Yes | Id of a channel from List conversations, or the id of a user from List users or Get user by email to message that person directly from the app. |
| text | string | Yes, in this text example | Text of the message, plain or in Slack mrkdwn, ideally under 4000 characters. With blocks it is only the notification fallback. |
| markdown_text | string | Alternative to text/blocks | The message in standard Markdown, up to 12000 characters. Do not send it together with text or blocks. |
| blocks | array | Content alternative | Block Kit layout blocks of the message, each with its type, such as section or divider. Send text too, as the notification fallback. |
| thread_ts | string | No | The ts of a parent message, from List messages, to post this message as a reply in its thread. |
| reply_broadcast | boolean | No | With thread_ts, true also shows the reply in the channel. |
| unfurl_links | boolean | No | true shows a preview of text-based links. |
| unfurl_media | boolean | No | false hides the preview of media links. |
Supported connections
Your customer connects their Slack account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/slack, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Illustrative success format
{
"ok": true,
"channel": "C0123456789",
"ts": "1234567890.123456",
"message": {
"text": "Hello! This is an example message."
}
}The content below is an example, not a recorded execution. Save X-Toolkit-Execution-Id when returned to look up the execution. Connect provides no retries or idempotency: repeating a POST may send the message again.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/slack_send_message. It becomes your agent's tool definition with no conversion.
Other Slack tools
- List conversationsGETLists the channels of the workspace: all public channels and the private channels the app was added to. The id of a channel is the channel argument of the other tools, and is_member tells whether the app is in it. The response has channels and response_metadata.next_cursor: pass it as cursor to read the next page.
- Create conversationPOSTCreates a public or private channel with the app as a member and returns it with its id. Add people to it with Invite members to conversation.
- Join conversationPOSTAdds the app to a public channel and returns the channel. The app must be a member to read the messages of a channel or post in it. A private channel cannot be joined this way: a member adds the app to it in Slack.
- Invite members to conversationPOSTInvites members of the workspace to a channel the app is in. If one of the ids fails, nobody is invited unless force is true.
- List messagesGETLists the messages of a channel the app is a member of, newest first. Thread replies are not included: read them with List thread replies. The response has messages, has_more and response_metadata.next_cursor: pass it as cursor to read the next page. An app installed from outside the Slack Marketplace can be held to 15 messages per call and one call per minute.
- List thread repliesGETLists a thread of a channel the app is a member of: the parent message followed by its replies. The response has messages, has_more and response_metadata.next_cursor: pass it as cursor to read the next page. An app installed from outside the Slack Marketplace can be held to 15 messages per call and one call per minute.
- Schedule messagePOSTSchedules a message from the app's bot for a moment up to 120 days ahead and returns its scheduled_message_id. Send text, markdown_text or blocks. The app must be a member of the channel, and a channel takes at most 30 scheduled messages within the same 5 minutes.
- Update messagePOSTEdits a message the app's bot posted and returns it. Sending text without blocks replaces the blocks of the message with that text; leaving text out keeps them.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
