docs-v2/content/flux/v0/stdlib/contrib/sranka/webexteams/message.md

title	description	menu	weight	flux/v0/tags
webexteams.message() function	`webexteams.message()` sends a single message to Webex using the [Webex messages API](https://developer.webex.com/docs/api/v1/messages/create-a-message).	flux_v0_ref name parent identifier webexteams.message contrib/sranka/webexteams contrib/sranka/webexteams/message	301	single notification

webexteams.message() sends a single message to Webex using the Webex messages API.

Function type signature

(
    markdown: A,
    roomId: B,
    text: C,
    token: string,
    ?url: string,
) => int

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

Parameters

url

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

token

({{< req >}}) Webex API access token.

roomId

({{< req >}}) Room ID to send the message to.

text

({{< req >}}) Plain text message.

markdown

({{< req >}}) Markdown formatted message.

Examples

Send the last reported status to Webex Teams

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

apiToken = secrets.get(key: "WEBEX_API_TOKEN")

lastReported =
    from(bucket: "example-bucket")
        |> range(start: -1m)
        |> filter(fn: (r) => r._measurement == "statuses")
        |> last()
        |> findRecord(fn: (key) => true, idx: 0)

webexteams.message(
    token: apiToken,
    roomId: "Y2lzY29zcGFyazovL3VzL1JPT00vYmJjZWIxYWQtNDNmMS0zYjU4LTkxNDctZjE0YmIwYzRkMTU0",
    text: "Disk usage is ${lastReported.status}.",
    markdown: "Disk usage is **${lastReported.status}**.",
)