pushover: A Haskell Pushover API library

[ bsd3, library, web ] [ Propose Tags ]

This package provides functionality to allow Haskell developers to interact with the Pushover API (https://pushover.net).

[Skip to Readme]
Versions [faq],
Dependencies aeson, base (>=4.7 && <5), bytestring, exceptions, http-client, http-client-tls, mtl, text, time, transformers, uri-encode [details]
License BSD-3-Clause
Copyright 2017 Dan Meakin
Author Dan Meakin
Maintainer dan@danmeakin.com
Revised Revision 1 made by DanMeakin at Sat Mar 4 11:54:28 UTC 2017
Category Web
Home page https://github.com/DanMeakin/pushover#readme
Source repo head: git clone https://github.com/DanMeakin/pushover
Uploaded by DanMeakin at Sat Mar 4 11:48:12 UTC 2017
Distributions NixOS:
Downloads 817 total (37 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2017-03-04 [all 1 reports]




Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees

Readme for pushover-

[back to package description]


This is a small library for interacting with the Pushover API from within Haskell.

Pushover exposes a straightforward API for sending notifications to users of the Android and iOS Pushover app. Details of the API can be found at https://pushover.net/api.


This library exposes a number of types which represent a Request and a Response, and fields contained within these values. It provides functions which can be used to create and make requests.


A basic request can be made as follows:-

>>> apiKey  = makeTokenOrError "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
>>> userKey = makeTokenOrError "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
>>> sendMessage apiK usrK $ text "This is a test"

Assuming the keys are correct, this should immediately send the notification to the user with userKey.

The makeTokenOrError function shown here should not generally be used. Instead, the makeToken function checks the validity of the token and wraps the output in Either.


A more useful approach is to integrate Pushover into your existing Monad stack. This can be accomplished using the createKeys and sendMessageM functions:-

>>> keys = createKeys "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyy"
>>> keys >>= runReaderT (sendMessageM $ text "This is a test")

The Monad-based functions (all with a trailing M in their name) require that a request is executed within a stack including an instance of MonadError and MonadIO. sendMessageM additionally requires a MonadReader and an instance of PushoverReader. See the Reader module for more details.