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!


Linux Package Signing Key Rotation

All signed InfluxData Linux packages have been resigned with an updated key. If using Linux, you may need to update your package configuration to continue to download and verify InfluxData software packages.

For more information, see the Linux Package Signing Key Rotation blog post.

InfluxDB Cloud backed by InfluxDB IOx

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by IOx, this is the correct documentation.

If powered by TSM, see the TSM-based InfluxDB Cloud documentation.

InfluxDB Cloud backed by InfluxDB TSM

All InfluxDB Cloud organizations created on or after January 31, 2023 are backed by the new InfluxDB IOx storage engine which enables nearly unlimited series cardinality and SQL query support. Check the right column of your InfluxDB Cloud organization homepage to see which InfluxDB storage engine you’re using.

If powered by TSM, this is the correct documentation.

If powered by IOx, see the IOx-based InfluxDB Cloud documentation.

State of the InfluxDB Cloud (IOx) documentation

The new documentation for InfluxDB Cloud backed by InfluxDB IOx 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.