docs-v2

2.7 KiB

Raw Permalink Blame History

title

description

weight

flux/v0/tags

slack.message() function

`slack.message()` sends a single message to a Slack channel and returns the HTTP response code of the request.

flux_v0_ref

name	parent	identifier
slack.message	slack	slack/message

101

single notification

slack.message() sends a single message to a Slack channel and returns the HTTP response code of the request.

The function works with either with the chat.postMessage API or with a Slack webhook.

Function type signature

(
    channel: A,
    color: string,
    text: B,
    ?token: string,
    ?url: string,
) => int

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

url

Slack API URL. Default is https://slack.com/api/chat.postMessage.

If using the Slack webhook API, this URL is provided in the Slack webhook setup process.

token

Slack API token. Default is "".

If using the Slack Webhook API, a token is not required.

channel

({{< req >}}) Slack channel or user to send the message to.

text

({{< req >}}) Message text.

color

({{< req >}}) Slack message color.

Valid values:

good
warning
danger
Any hex RGB color code

Examples

Send a message to Slack using a Slack webhook
Send a message to Slack using chat.postMessage API

Send a message to Slack using a Slack webhook

import "slack"

slack.message(
    url: "https://hooks.slack.com/services/EXAMPLE-WEBHOOK-URL",
    channel: "#example-channel",
    text: "Example slack message",
    color: "warning",
)

Send a message to Slack using chat.postMessage API

import "slack"

slack.message(
    url: "https://slack.com/api/chat.postMessage",
    token: "mySuPerSecRetTokEn",
    channel: "#example-channel",
    text: "Example slack message",
    color: "warning",
)

2.7 KiB Raw Permalink Blame History