Documentation

servicenow.event() function

servicenow.event() is a user-contributed function maintained by the package author.

servicenow.event() sends an event to ServiceNow.

ServiceNow Event API fields are described in ServiceNow Create Event documentation.

Function type signature
(
    description: A,
    password: string,
    severity: B,
    url: string,
    username: string,
    ?additionalInfo: C,
    ?messageKey: D,
    ?metricName: E,
    ?metricType: F,
    ?node: G,
    ?resource: H,
    ?source: I,
) => int where B: Equatable, C: Equatable

For more information, see Function type signatures.

Parameters

url

(Required) ServiceNow web service URL.

username

(Required) ServiceNow username to use for HTTP BASIC authentication.

password

(Required) ServiceNow password to use for HTTP BASIC authentication.

description

(Required) Event description.

severity

(Required) Severity of the event.

Supported values:

  • critical
  • major
  • minor
  • warning
  • info
  • clear

source

Source name. Default is "Flux".

node

Node name or IP address related to the event. Default is an empty string ("").

metricType

Metric type related to the event (for example, CPU). Default is an empty string ("").

resource

Resource related to the event (for example, CPU-1). Default is an empty string ("").

metricName

Metric name related to the event (for example, usage_idle). Default is an empty string ("").

messageKey

Unique identifier of the event (for example, the InfluxDB alert ID). Default is an empty string (""). If an empty string, ServiceNow generates a value.

additionalInfo

Additional information to include with the event.

Examples

Send the last reported value and incident type to ServiceNow

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

username = secrets.get(key: "SERVICENOW_USERNAME")
password = secrets.get(key: "SERVICENOW_PASSWORD")

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

servicenow.event(
    url: "https://tenant.service-now.com/api/global/em/jsonv2",
    username: username,
    password: password,
    node: lastReported.host,
    metricType: lastReported._measurement,
    resource: lastReported.instance,
    metricName: lastReported._field,
    severity:
        if lastReported._value < 1.0 then
            "critical"
        else if lastReported._value < 5.0 then
            "warning"
        else
            "info",
    additionalInfo: {"devId": r.dev_id},
)

Was this page helpful?

Thank you for your feedback!


New in InfluxDB 3.5

Key enhancements in InfluxDB 3.5 and the InfluxDB 3 Explorer 1.3.

See the Blog Post

InfluxDB 3.5 is now available for both Core and Enterprise, introducing custom plugin repository support, enhanced operational visibility with queryable CLI parameters and manual node management, stronger security controls, and general performance improvements.

InfluxDB 3 Explorer 1.3 brings powerful new capabilities including Dashboards (beta) for saving and organizing your favorite queries, and cache querying for instant access to Last Value and Distinct Value caches—making Explorer a more comprehensive workspace for time series monitoring and analysis.

For more information, check out:

InfluxDB Docker latest tag changing to InfluxDB 3 Core

On November 3, 2025, the latest tag for InfluxDB Docker images will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments.

If using Docker to install and run InfluxDB, the latest tag will point to InfluxDB 3 Core. To avoid unexpected upgrades, use specific version tags in your Docker deployments. For example, if using Docker to run InfluxDB v2, replace the latest version tag with a specific version tag in your Docker pull command–for example:

docker pull influxdb:2