Documentation

discord.endpoint() function

discord.endpoint() is a user-contributed function maintained by the package author.

discord.endpoint() sends a single message to a Discord channel using a Discord webhook and data from table rows.

Usage

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

mapFn

A function that builds the record used to generate the Discord webhook request. Requires an r parameter.

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

  • content

For more information, see the discord.send() content parameter.

Function type signature
(
    username: A,
    webhookID: string,
    webhookToken: string,
    ?avatar_url: B,
) => (mapFn: (r: C) => {D with content: E}) => (<-tables: stream[C]) => stream[{C with _sent: string}]
For more information, see Function type signatures.

Parameters

webhookToken

(Required) Discord webhook token.

webhookID

(Required) Discord webhook ID.

username

(Required) Override the Discord webhook’s default username.

avatar_url

Override the Discord webhook’s default avatar.

Examples

Send critical statuses to a Discord channel

import "influxdata/influxdb/secrets"
import "contrib/chobbs/discord"

discordToken = secrets.get(key: "DISCORD_TOKEN")
endpoint =
    telegram.endpoint(webhookToken: discordToken, webhookID: "123456789", username: "critBot")

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

crit_statuses
    |> endpoint(mapFn: (r) => ({content: "The status is critical!"}))()

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: