Advanced Alerting APIs
PagerDuty Interface Reference

Provides a client to PagerDuty. It provides calls to trigger, resolve and get the status of open incidents. More...

List of all members.

Public Member Functions

string trigger (object args)
string trigger (string serviceKey, string message)
string trigger (string serviceKey, string message, string incidentKey)
void resolve (string serviceKey, string message, string incidentKey)

Detailed Description

Provides a client to PagerDuty. It provides calls to trigger, resolve and get the status of open incidents.

Author:
Matt Rodriguez

Member Function Documentation

void resolve ( string  serviceKey,
string  message,
string  incidentKey 
)

Resolve the PagerDuty incident. Use this function in your alert policy script by calling neustar.pagerDuty.resolve

Parameters:
serviceKeyA string of your PagerDuty service key.
messageA string that explains how the incident was resolved.
incidentKeyA string of the incident to resolve.
string trigger ( object  args)

Trigger a PagerDuty incident. Use this function in your alert policy script by calling neustar.pagerDuty.trigger;

Parameters:
argsis a javascript object which must contain
  • serviceKey
  • message
The serviceKey attribute is a string of your PagerDuty service key. The messsage attribute is a string that is the message which explains the incident. the object may also contain
  • incidentKey
  • details
The incidentKey attribute is a string that assigns this event to an existing incident. The details atribute is a javascript object which contains additional details about an event.
Returns:
A string of the incident key.
string trigger ( string  serviceKey,
string  message 
)
Deprecated:

Trigger a PagerDuty incident. Use this function in your alert policy script by calling neustar.pagerDuty.trigger;

Parameters:
serviceKeyA string of your PagerDuty service key.
messageA string that is the message which explains the incident.
Returns:
A string of the incident key.
string trigger ( string  serviceKey,
string  message,
string  incidentKey 
)
Deprecated:

Trigger a PagerDuty incident. Use this function in your alert policy script by calling neustar.pagerDuty.trigger

Parameters:
serviceKeyA string of your PagerDuty service key.
messageA string that is the message which explains the incident.
incidentKeyA string that assigns this event to an existing incident.
Returns:
A string of the incident key.
 All Classes Functions