@@ -1,7 +1,7 @@
11<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Network.PagerDuty.Integration</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
22window.onload = function () {pageLoad();setSynopsis("mini_Network-PagerDuty-Integration.html");};
33//]]>
4−</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">pagerduty-0.1.0: Pager Duty API Client</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Network.PagerDuty.Integration</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Events</a><ul><li><a href="#g:2">Trigger</a></li><li><a href="#g:3">Acknowledge</a></li><li><a href="#g:4">Resolve</a></li></ul></li><li><a href="#g:5">Types</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The PagerDuty event integration API is how you would add PagerDuty's
4+</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">pagerduty-0.0.0: Pager Duty API Client</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">Network.PagerDuty.Integration</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Events</a><ul><li><a href="#g:2">Trigger</a></li><li><a href="#g:3">Acknowledge</a></li><li><a href="#g:4">Resolve</a></li></ul></li><li><a href="#g:5">Types</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The PagerDuty event integration API is how you would add PagerDuty's
55 advanced alerting functionality to any system that can make an HTTP API
66 call. You can now add phone, SMS and email alerting to your monitoring
77 tools, ticketing systems and custom software.</p><p>The API was designed to allow you to easily integrate a
@@ -13,7 +13,7 @@ window.onload = function () {pageLoad();setSynopsis("mini_Network-PagerDuty-Inte
1313 events. Incoming events (sent via the API) are routed to a PagerDuty
1414 service and processed. They may result in a new incident being created,
1515 or an existing incident being acknowledged or resolved.</p><p>The same event-based API can also be used to integrate a PagerDuty
16− service with ticketing systems and various other software tools.</p><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/integration/events">http://developer.pagerduty.com/documentation/integration/events</a></p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:submit">submit</a> :: (MonadIO m, <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a) => Manager -> a -> m (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Either.html#t:Either">Either</a> Error <a href="Network-PagerDuty-Integration.html#t:Response">Response</a>)</li><li class="src short"><span class="keyword">data</span> <a href="#t:Trigger">Trigger</a></li><li class="src short"><a href="#v:trigger">trigger</a> :: ServiceKey -> Text -> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></li><li class="src short"><a href="#v:tDescription">tDescription</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> Text</li><li class="src short"><a href="#v:tIncidentKey">tIncidentKey</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> IncidentKey)</li><li class="src short"><a href="#v:tClient">tClient</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:tClientUrl">tClientUrl</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:tDetails">tDetails</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> Object</li><li class="src short"><span class="keyword">data</span> <a href="#t:Acknowledge">Acknowledge</a></li><li class="src short"><a href="#v:acknowledge">acknowledge</a> :: ServiceKey -> IncidentKey -> <a href="Network-PagerDuty-Integration.html#t:Acknowledge">Acknowledge</a></li><li class="src short"><a href="#v:aDescription">aDescription</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Acknowledge">Acknowledge</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:aDetails">aDetails</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Acknowledge">Acknowledge</a> Object</li><li class="src short"><span class="keyword">data</span> <a href="#t:Resolve">Resolve</a></li><li class="src short"><a href="#v:resolve">resolve</a> :: ServiceKey -> IncidentKey -> <a href="Network-PagerDuty-Integration.html#t:Resolve">Resolve</a></li><li class="src short"><a href="#v:rDescription">rDescription</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Resolve">Resolve</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:rDetails">rDetails</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Resolve">Resolve</a> Object</li><li class="src short"><span class="keyword">class</span> <a href="#t:Event">Event</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:AnyEvent">AnyEvent</a> <span class="keyword">where</span><ul class="subs"><li><a href="#v:Event">Event</a> :: <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a => a -> <a href="Network-PagerDuty-Integration.html#t:AnyEvent">AnyEvent</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Response">Response</a></li><li class="src short"><a href="#v:rsStatus">rsStatus</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Response">Response</a> Text</li><li class="src short"><a href="#v:rsMessage">rsMessage</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Response">Response</a> Text</li><li class="src short"><a href="#v:rsIncidentKey">rsIncidentKey</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Response">Response</a> IncidentKey</li></ul></div><div id="interface"><h1 id="g:1">Events</h1><div class="top"><p class="src"><a name="v:submit" class="def">submit</a> :: (MonadIO m, <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a) => Manager -> a -> m (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Either.html#t:Either">Either</a> Error <a href="Network-PagerDuty-Integration.html#t:Response">Response</a>)</p><div class="doc"><p>Send an event to the integration API.</p></div></div><h2 id="g:2">Trigger</h2><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Trigger" class="def">Trigger</a></p><div class="subs instances"><p id="control.i:Trigger" class="caption collapser" onclick="toggleSection('i:Trigger')">Instances</p><div id="section.i:Trigger" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-Integration.html#t:Event">Event</a> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:trigger" class="def">trigger</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: ServiceKey</td><td class="doc empty"> </td></tr><tr><td class="src">-> Text</td><td class="doc"><p><code><a href="Network-PagerDuty-Integration.html#v:tDescription">tDescription</a></code></p></td></tr><tr><td class="src">-> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Your monitoring tools should send PagerDuty a trigger event to report a new
16+ service with ticketing systems and various other software tools.</p><p><em>See:</em> <a href="http://developer.pagerduty.com/documentation/integration/events">http://developer.pagerduty.com/documentation/integration/events</a></p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:submit">submit</a> :: (MonadIO m, <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a) => Manager -> a -> m (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Either.html#t:Either">Either</a> Error <a href="Network-PagerDuty-Integration.html#t:Response">Response</a>)</li><li class="src short"><a href="#v:submitWith">submitWith</a> :: (MonadIO m, <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a) => Manager -> Logger -> a -> m (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Either.html#t:Either">Either</a> Error <a href="Network-PagerDuty-Integration.html#t:Response">Response</a>)</li><li class="src short"><span class="keyword">data</span> <a href="#t:Trigger">Trigger</a></li><li class="src short"><a href="#v:trigger">trigger</a> :: ServiceKey -> Text -> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></li><li class="src short"><a href="#v:tDescription">tDescription</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> Text</li><li class="src short"><a href="#v:tIncidentKey">tIncidentKey</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> IncidentKey)</li><li class="src short"><a href="#v:tClient">tClient</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:tClientUrl">tClientUrl</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:tDetails">tDetails</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> Object</li><li class="src short"><span class="keyword">data</span> <a href="#t:Acknowledge">Acknowledge</a></li><li class="src short"><a href="#v:acknowledge">acknowledge</a> :: ServiceKey -> IncidentKey -> <a href="Network-PagerDuty-Integration.html#t:Acknowledge">Acknowledge</a></li><li class="src short"><a href="#v:aDescription">aDescription</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Acknowledge">Acknowledge</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:aDetails">aDetails</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Acknowledge">Acknowledge</a> Object</li><li class="src short"><span class="keyword">data</span> <a href="#t:Resolve">Resolve</a></li><li class="src short"><a href="#v:resolve">resolve</a> :: ServiceKey -> IncidentKey -> <a href="Network-PagerDuty-Integration.html#t:Resolve">Resolve</a></li><li class="src short"><a href="#v:rDescription">rDescription</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Resolve">Resolve</a> (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Maybe.html#t:Maybe">Maybe</a> Text)</li><li class="src short"><a href="#v:rDetails">rDetails</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Resolve">Resolve</a> Object</li><li class="src short"><span class="keyword">class</span> <a href="#t:Event">Event</a> a</li><li class="src short"><span class="keyword">data</span> <a href="#t:AnyEvent">AnyEvent</a> <span class="keyword">where</span><ul class="subs"><li><a href="#v:Event">Event</a> :: <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a => a -> <a href="Network-PagerDuty-Integration.html#t:AnyEvent">AnyEvent</a></li></ul></li><li class="src short"><span class="keyword">data</span> <a href="#t:Response">Response</a></li><li class="src short"><a href="#v:rsStatus">rsStatus</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Response">Response</a> Text</li><li class="src short"><a href="#v:rsMessage">rsMessage</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Response">Response</a> Text</li><li class="src short"><a href="#v:rsIncidentKey">rsIncidentKey</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Response">Response</a> IncidentKey</li></ul></div><div id="interface"><h1 id="g:1">Events</h1><div class="top"><p class="src"><a name="v:submit" class="def">submit</a> :: (MonadIO m, <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a) => Manager -> a -> m (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Either.html#t:Either">Either</a> Error <a href="Network-PagerDuty-Integration.html#t:Response">Response</a>)</p><div class="doc"><p>Send an event to the integration API.</p></div></div><div class="top"><p class="src"><a name="v:submitWith" class="def">submitWith</a> :: (MonadIO m, <a href="Network-PagerDuty-Integration.html#t:Event">Event</a> a) => Manager -> Logger -> a -> m (<a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Either.html#t:Either">Either</a> Error <a href="Network-PagerDuty-Integration.html#t:Response">Response</a>)</p><div class="doc"><p><em>See:</em> <code><a href="Network-PagerDuty-Integration.html#v:submit">submit</a></code></p></div></div><h2 id="g:2">Trigger</h2><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:Trigger" class="def">Trigger</a></p><div class="subs instances"><p id="control.i:Trigger" class="caption collapser" onclick="toggleSection('i:Trigger')">Instances</p><div id="section.i:Trigger" class="show"><table><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Data-Eq.html#t:Eq">Eq</a> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="file:///Users/brendanhay/ghc/share/doc/ghc/html/libraries/base-4.7.0.1/Text-Show.html#t:Show">Show</a> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src">ToJSON <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src">FromJSON <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Network-PagerDuty-Integration.html#t:Event">Event</a> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><a name="v:trigger" class="def">trigger</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: ServiceKey</td><td class="doc empty"> </td></tr><tr><td class="src">-> Text</td><td class="doc"><p><code><a href="Network-PagerDuty-Integration.html#v:tDescription">tDescription</a></code></p></td></tr><tr><td class="src">-> <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a></td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Your monitoring tools should send PagerDuty a trigger event to report a new
1717 or ongoing problem. When PagerDuty receives a trigger event, it will either open
1818 a new incident, or add a new trigger log entry to an existing incident,
1919 depending on the provided incident_key.</p></div></div><div class="top"><p class="src"><a name="v:tDescription" class="def">tDescription</a> :: Lens' <a href="Network-PagerDuty-Integration.html#t:Trigger">Trigger</a> Text</p><div class="doc"><p>A short description of the problem that led to this trigger.