Alerts

An alert represents an urgent notice (state of alarm)
Alerts are created by Integrations or Account Users​
The Alert Object
Property
Type
Description
title
string
The title of the alert.
description
string
The description of the alert.
tag_list
string[]
A list of tags.
urgency
string
The urgency of the alert. low|medium|high|critical
status
string
The current status state of the alert.
source_id
string
The source identifier.
source_type
string
The source model type (usually an Integration or Account User).
source_log_id
string
The Log identifier that created this alert (only when created by an integration).
thirdparty_id
string
A unique identifier mapping this to a third party system.
acknowledged_at
timestamp
A timestamp of when the alert was first acknowledged. (Does not get reset if handed off or the alert was routed to multiple teams.)
resolved_at
timestamp
A timestamp of when the alert was resolved.
dedup_keys
string[]
Unique identifiers that group alerts within the account.
Notes
Set the meta.incident to true to flag this alert as an incident.
Set the meta.incident_severity to set the severity. SEV-1|SEV-2|SEV-3|SEV-4|SEV-5|SEV-UNKNOWN
Set the meta.incident_message to set the special incident message.
Create an Alert
POST https://api.pagertree.com/api/v4/alerts
Allowed Parameters
def alert_params
  params.permit(
    :title,
    :description,
    :urgency,
    meta: [
      :incident,
      :incident_severity,
      :incident_message
    ],
    destination_team_ids: [],
    destination_router_ids: [],
    destination_account_user_ids: []
  )
end
Required Parameters
title
urgency
at least 1 destination (Team, Router, or Account User)
Retrieve an Alert
GET https://api.pagertree.com/api/v4/alerts/:id
Update an Alert
PUT https://api.pagertree.com/api/v4/alerts/:id
Delete an Alert
DELETE https://api.pagertree.com/api/v4/alerts/:id
List all Alerts
GET https://api.pagertree.com/api/v4/alerts
Acknowledge an Alert
​Acknowledge an alert. Must be in the open|dropped|suppressed state.
POST https://api.pagertree.com/api/v4/alerts/:id/acknowledge
Reject an Alert
​Reject an alert. API Key user must have an open workflow for this alert.
POST https://api.pagertree.com/api/v4/alerts/:id/reject
Resolve an Alert
​Resolve an alert. Must be in the open|dropped|acknowledged state.
POST https://api.pagertree.com/api/v4/alerts/:id/resolve

Property	Type	Description
title	string	The title of the alert.
description	string	The description of the alert.
tag_list	string[]	A list of tags.
urgency	string	The urgency of the alert. `low\|medium\|high\|critical`
status	string	The current status state of the alert.
source_id	string	The source identifier.
source_type	string	The source model type (usually an Integration or Account User).
source_log_id	string	The Log identifier that created this alert (only when created by an integration).
thirdparty_id	string	A unique identifier mapping this to a third party system.
acknowledged_at	timestamp	A timestamp of when the alert was first acknowledged. (Does not get reset if handed off or the alert was routed to multiple teams.)
resolved_at	timestamp	A timestamp of when the alert was resolved.
dedup_keys	string[]	Unique identifiers that group alerts within the account.

Last modified 1mo ago