Documentation

pagerduty.sendEvent() function

pagerduty.sendEvent() sends an event to PagerDuty and returns the HTTP response code of the request.

Function type signature
(
    class: A,
    client: B,
    clientURL: C,
    dedupKey: D,
    eventAction: E,
    group: F,
    routingKey: G,
    severity: H,
    source: I,
    summary: string,
    timestamp: J,
    ?component: K,
    ?customDetails: L,
    ?pagerdutyURL: string,
) => int where L: Equatable
For more information, see Function type signatures.

Parameters

pagerdutyURL

PagerDuty endpoint URL.

Default is https://events.pagerduty.com/v2/enqueue.

routingKey

(Required) Routing key generated from your PagerDuty integration.

client

(Required) Name of the client sending the alert.

clientURL

(Required) URL of the client sending the alert.

dedupKey

(Required) Per-alert ID that acts as deduplication key and allows you to acknowledge or change the severity of previous messages. Supports a maximum of 255 characters.

class

(Required) Class or type of the event.

Classes are user-defined. For example, ping failure or cpu load.

group

(Required) Logical grouping used by PagerDuty.

Groups are user-defined. For example, app-stack.

severity

(Required) Severity of the event.

Valid values:

  • critical
  • error
  • warning
  • info

eventAction

(Required) Event type to send to PagerDuty.

Valid values:

  • trigger
  • resolve
  • acknowledge

source

(Required) Unique location of the affected system. For example, the hostname or fully qualified domain name (FQDN).

component

Component responsible for the event.

summary

(Required) Brief text summary of the event used as the summaries or titles of associated alerts. The maximum permitted length is 1024 characters.

timestamp

(Required) Time the detected event occurred in RFC3339nano format.

customDetails

Record with additional details about the event.

Examples

Send an event to PagerDuty

import "pagerduty"
import "pagerduty"

pagerduty.sendEvent(
    routingKey: "example-routing-key",
    client: "example-client",
    clientURL: "http://example-url.com",
    dedupKey: "example-dedup-key",
    class: "example-class",
    eventAction: "trigger",
    group: "example-group",
    severity: "crit",
    component: "example-component",
    source: "example-source",
    summary: "example-summary",
    timestamp: now(),
    customDetails: {"example-key": "example value"},
)

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:

State of the InfluxDB Cloud Serverless documentation

InfluxDB Cloud Serverless documentation is a work in progress.

The new documentation for InfluxDB Cloud Serverless is a work in progress. We are adding new information and content almost daily. Thank you for your patience!

If there is specific information you’re looking for, please submit a documentation issue.