Safe Haskell	None
Language	Haskell2010

Network.PagerDuty.REST.Alerts

Contents

List Alerts
Types

Description

When an incident is triggered or when it is escalated it creates an alert (also known as a notification). Alerts are messages containing the details of the incident, and can be sent through SMS, email, phone calls, and push notifications.

This API allows you to access read-only data regarding what alerts have been sent to your users.

See: http://developer.pagerduty.com/documentation/rest/alerts

Synopsis

List Alerts

data ListAlerts Source

Instances

Eq ListAlerts
Show ListAlerts
ToJSON ListAlerts
HasDatatypeInfo ListAlerts
Generic ListAlerts
QueryLike ListAlerts
type Code ListAlerts

listAlerts Source

Arguments

:: Date	`laSince`
-> Date	`laUntil`
-> Request ListAlerts s [Alert]

List existing alerts for a given time range, optionally filtered by type (SMS, Email, Phone, or Push).

GET /alerts

See: http://developer.pagerduty.com/documentation/rest/alerts/list

laSince :: Lens' (Request ListAlerts s b) UTCTime Source

The start of the date range over which you want to search.

laUntil :: Lens' (Request ListAlerts s b) UTCTime Source

The end of the date range over which you want to search. This should be in the same format as since.

The size of the date range must be less than 3 months.

laFilter :: Lens' (Request ListAlerts s b) (Maybe AlertType) Source

Returns only the alerts of the said AlertType type.

laTimeZone :: Lens' (Request ListAlerts s b) (Maybe TimeZone) Source

Time zone in which dates in the result will be rendered.

Default: account time zone.

Types

data AlertType Source

Constructors

SMS
Email
Phone
Push

Instances

Eq AlertType
Show AlertType
ToJSON AlertType
FromJSON AlertType

data Alert Source

Instances

Eq Alert
Show Alert
ToJSON Alert
FromJSON Alert

alertId :: Lens' Alert AlertId Source

alertType :: Lens' Alert AlertType Source

alertStartedAt :: Lens' Alert Date Source

alertUser :: Lens' Alert User Source

alertAddress :: Lens' Alert Address Source