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:
-
serviceKey | A string of your PagerDuty service key. |
message | A string that explains how the incident was resolved. |
incidentKey | A string of the incident to resolve. |
Trigger a PagerDuty incident. Use this function in your alert policy script by calling neustar.pagerDuty.trigger;
- Parameters:
-
args | is a javascript object which must contain
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
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:
-
serviceKey | A string of your PagerDuty service key. |
message | A 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:
-
serviceKey | A string of your PagerDuty service key. |
message | A string that is the message which explains the incident. |
incidentKey | A string that assigns this event to an existing incident. |
- Returns:
- A string of the incident key.