zenoss.endpoint() function

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

zenoss.endpoint() sends events to Zenoss using data from input rows.


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


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:

  • summary
  • device
  • component
  • severity
  • eventClass
  • eventClassKey
  • collector
  • message

For more information, see zenoss.event() parameters.

Function type signature
    url: string,
    ?action: A,
    ?apiKey: B,
    ?method: C,
    ?password: string,
    ?tid: D,
    ?type: E,
    ?username: string,
) => (
    mapFn: (
        r: F,
    ) => {
        G with
        summary: O,
        severity: N,
        message: M,
        eventClassKey: L,
        eventClass: K,
        device: J,
        component: I,
        collector: H,
) => (<-tables: stream[F]) => stream[{F with _sent: string}] where B: Equatable

For more information, see Function type signatures.



(Required) Zenoss router endpoint URL.


Zenoss username to use for HTTP BASIC authentication. Default is "" (no authentication).


Zenoss password to use for HTTP BASIC authentication. Default is "" (no authentication).


Zenoss cloud API key. Default is "" (no API key).


Zenoss router name. Default is "EventsRouter".


EventsRouter method. Default is "add_event".


Event type. Default is "rpc".


Temporary request transaction ID. Default is 1.


Send critical events to Zenoss

import "contrib/bonitoo-io/zenoss"
import "influxdata/influxdb/secrets"

url = ""
username = secrets.get(key: "ZENOSS_USERNAME")
password = secrets.get(key: "ZENOSS_PASSWORD")
endpoint = zenoss.endpoint(url: url, username: username, password: password)

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

    |> endpoint(
        mapFn: (r) =>
                summary: "Critical event for ${}",
                device: r.deviceID,
                severity: "Critical",
                eventClass: "/App",
                eventClassKey: "",
                collector: "",
                message: "${} is in a critical state.",

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.

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: