Documentation

slack.endpoint() function

The slack.endpoint() function sends a message to Slack that includes output data.

import "slack"

slack.endpoint(
    url: "https://slack.com/api/chat.postMessage",
    token: "mySuPerSecRetTokEn",
)

Parameters

url

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

If using a Slack webhook, you’ll receive a Slack webhook URL when you create an incoming webhook.

token

The Slack API token used to interact with Slack. Default is "".

A token is only required if using the Slack chat.postMessage API.

Usage

slack.endpoint is a factory function that outputs another function. The output function requires a mapFn parameter.

mapFn

(Required) A function that builds the record used to generate the POST request. Requires an r parameter.

mapFn accepts a table row (r) and returns a record that must include the following fields:

  • channel
  • text
  • color

For more information, see slack.message()

Examples

Send critical statuses to a Slack endpoint
import "slack"
import "influxdata/influxdb/secrets"

token = secrets.get(key: "SLACK_TOKEN")
toSlack = slack.endpoint(token: token)

crit_statuses = from(bucket: "example-bucket")
    |> range(start: -1m)
    |> filter(fn: (r) => r._measurement == "statuses" and r.status == "crit")

crit_statuses
    |> toSlack(mapFn: (r) => ({channel: "Alerts", text: r._message, color: "danger"}))()

Was this page helpful?

Thank you for your feedback!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.