Documentation

webexteams.endpoint() function

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

webexteams.endpoint() returns a function that sends a message that includes data from input rows to a Webex room.

Usage

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

mapFn

A function that builds the object used to generate the POST request. Requires an r parameter.

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

  • roomId
  • text
  • markdown

For more information, see webexteams.message parameters.

Function type signature
(
    token: string,
    ?url: string,
) => (
    mapFn: (r: A) => {B with text: E, roomId: D, markdown: C},
) => (<-tables: stream[A]) => stream[{A with _sent: string}]

For more information, see Function type signatures.

Parameters

url

Base URL of Webex API endpoint (without a trailing slash). Default is https://webexapis.com.

token

(Required) Webex API access token.

Examples

Send the last reported status to Webex Teams

import "contrib/sranka/webexteams"
import "influxdata/influxdb/secrets"

token = secrets.get(key: "WEBEX_API_KEY")

from(bucket: "example-bucket")
    |> range(start: -1m)
    |> filter(fn: (r) => r._measurement == "statuses")
    |> last()
    |> tableFind(fn: (key) => true)
    |> webexteams.endpoint(token: token)(
        mapFn: (r) =>
            ({
                roomId:
                    "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
                text: "",
                markdown: "Disk usage is **${r.status}**.",
            }),
    )()

Was this page helpful?

Thank you for your feedback!


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.

Read more

New in InfluxDB 3.4

Key enhancements in InfluxDB 3.4 and the InfluxDB 3 Explorer 1.2.

See the Blog Post

InfluxDB 3.4 is now available for both Core and Enterprise, which introduces offline token generation for use in automated deployments and configurable license type selection that lets you bypass the interactive license prompt. InfluxDB 3 Explorer 1.2 is also available, which includes InfluxDB cache management and other new features.

For more information, check out: