Copyright	(c) Dustin Sallings 2021
License	BSD3
Maintainer	dustin@spy.net
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.API.PagerDuty.EventV1

Contents

Triggering an Event
Updating an Event
Delivering Events to PagerDuty

Description

PagerDuty Event V1 interface.

Synopsis

data TriggerEvent a = TriggerEvent {
- _teServiceKey :: Text
- _teIncidentKey :: Maybe Text
- _teDescription :: Text
- _teDetails :: Maybe a
- _teClient :: Text
- _teClientURL :: Text
- _teContexts :: [Context]
}
type TriggerEvent' = TriggerEvent ()
data Context
- = Link Text (Maybe Text)
- | Image Text (Maybe Text) (Maybe Text)
data UpdateEvent a = UpdateEvent {
- _updateType :: UpdateType
- _updateServiceKey :: Text
- _updateIncidentKey :: Text
- _updateDescription :: Text
- _updateDetails :: Maybe a
}
type UpdateEvent' = UpdateEvent ()
data UpdateType
- = Acknowledge
- | Resolve
deliver :: (EventRequest r, MonadCatch m, MonadIO m) => r -> m Response
data Response
- = Failure Text Text
- | Success Text

Triggering an Event

data TriggerEvent a Source #

Request object to create an event. Any value that may be serialized to JSON maybe attached as details.

This may be delivered with the deliver function.

Constructors

TriggerEvent
Fields _teServiceKey :: Text _teIncidentKey :: Maybe Text _teDescription :: Text _teDetails :: Maybe a _teClient :: Text _teClientURL :: Text _teContexts :: [Context]

Instances

Instances details

ToJSON a => ToJSON (TriggerEvent a) Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods toJSON :: TriggerEvent a -> Value # toEncoding :: TriggerEvent a -> Encoding # toJSONList :: [TriggerEvent a] -> Value # toEncodingList :: [TriggerEvent a] -> Encoding # omitField :: TriggerEvent a -> Bool #
Show a => Show (TriggerEvent a) Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods showsPrec :: Int -> TriggerEvent a -> ShowS # show :: TriggerEvent a -> String # showList :: [TriggerEvent a] -> ShowS #
Eq a => Eq (TriggerEvent a) Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods (==) :: TriggerEvent a -> TriggerEvent a -> Bool # (/=) :: TriggerEvent a -> TriggerEvent a -> Bool #

type TriggerEvent' = TriggerEvent () Source #

A TriggerEvent type that doesn't have details.

data Context Source #

Context that may be added when creating an event.

Constructors

Link Text (Maybe Text)	Link to a URL with an optional link description.
Image Text (Maybe Text) (Maybe Text)	Image URL, optional link ref, and optional alt text.

Instances

Instances details

ToJSON Context Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods toJSON :: Context -> Value # toEncoding :: Context -> Encoding # toJSONList :: [Context] -> Value # toEncodingList :: [Context] -> Encoding # omitField :: Context -> Bool #
Show Context Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods showsPrec :: Int -> Context -> ShowS # show :: Context -> String # showList :: [Context] -> ShowS #
Eq Context Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods (==) :: Context -> Context -> Bool # (/=) :: Context -> Context -> Bool #

Updating an Event

data UpdateEvent a Source #

UpdateEvent is the message for both acknowledging and resolving incidents. This may be delivered using the deliver function.

Constructors

UpdateEvent
Fields _updateType :: UpdateType _updateServiceKey :: Text _updateIncidentKey :: Text _updateDescription :: Text _updateDetails :: Maybe a

Instances

Instances details

ToJSON a => ToJSON (UpdateEvent a) Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods toJSON :: UpdateEvent a -> Value # toEncoding :: UpdateEvent a -> Encoding # toJSONList :: [UpdateEvent a] -> Value # toEncodingList :: [UpdateEvent a] -> Encoding # omitField :: UpdateEvent a -> Bool #
Show a => Show (UpdateEvent a) Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods showsPrec :: Int -> UpdateEvent a -> ShowS # show :: UpdateEvent a -> String # showList :: [UpdateEvent a] -> ShowS #
Eq a => Eq (UpdateEvent a) Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods (==) :: UpdateEvent a -> UpdateEvent a -> Bool # (/=) :: UpdateEvent a -> UpdateEvent a -> Bool #

type UpdateEvent' = UpdateEvent () Source #

A UpdateEvent type that doesn't have details.

data UpdateType Source #

An event update will either acknowledge or resolve an incident.

Constructors

Acknowledge
Resolve

Instances

Instances details

Bounded UpdateType Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods minBound :: UpdateType # maxBound :: UpdateType #
Enum UpdateType Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods succ :: UpdateType -> UpdateType # pred :: UpdateType -> UpdateType # toEnum :: Int -> UpdateType # fromEnum :: UpdateType -> Int # enumFrom :: UpdateType -> [UpdateType] # enumFromThen :: UpdateType -> UpdateType -> [UpdateType] # enumFromTo :: UpdateType -> UpdateType -> [UpdateType] # enumFromThenTo :: UpdateType -> UpdateType -> UpdateType -> [UpdateType] #
Show UpdateType Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods showsPrec :: Int -> UpdateType -> ShowS # show :: UpdateType -> String # showList :: [UpdateType] -> ShowS #
Eq UpdateType Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods (==) :: UpdateType -> UpdateType -> Bool # (/=) :: UpdateType -> UpdateType -> Bool #

Delivering Events to PagerDuty

deliver :: (EventRequest r, MonadCatch m, MonadIO m) => r -> m Response Source #

Deliver a TriggerEvent or UpdateEvent.

data Response Source #

Response to a delivered message.

Constructors

Failure Text Text	Failure status and message
Success Text	Success and incident key for further updates

Instances

Instances details

FromJSON Response Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods parseJSON :: Value -> Parser Response # parseJSONList :: Value -> Parser [Response] # omittedField :: Maybe Response #
Show Response Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods showsPrec :: Int -> Response -> ShowS # show :: Response -> String # showList :: [Response] -> ShowS #
Eq Response Source #
Instance details Defined in Network.API.PagerDuty.EventV1 Methods (==) :: Response -> Response -> Bool # (/=) :: Response -> Response -> Bool #