The mattermost-api package

[Tags:bsd3, library, test]

Client API for Mattermost chat system

[Skip to Readme]


Versions 30802.1.0, 31000.0.0, 40000.0.0, 40000.0.1
Change log
Dependencies aeson (>=, base (>=4.4 && <5), binary (>=0.8.1), bytestring, connection, containers, gitrev, hashable, HTTP, mattermost-api, memory (<0.14.3), microlens, microlens-th, network-uri, pretty-show, process, stm, template-haskell, text, time, unordered-containers, websockets (>= [details]
License BSD3
Copyright 2016-2017 Jason Dagit, Getty Ritter, Jonathan Daugherty
Author Jason Dagit
Category Web
Source repository head: git clone
Uploaded Fri Jul 28 17:05:25 UTC 2017 by JonathanDaugherty
Distributions NixOS:40000.0.1
Downloads 196 total (83 in the last 30 days)
0 []
Status Docs available [build log]
Last success reported on 2017-07-28 [all 1 reports]
Hackage Matrix CI





Build example applications


Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info


Maintainer's Corner

For package maintainers and hackage trustees

Readme for mattermost-api

Readme for mattermost-api-40000.0.1



Client side API for communicating with a Mattermost server, in Haskell.


We use the MaterMost docker image for detecting changes in the API. See .travis.yml or the Mattermost docs for the details.

If you are testing your changes locally during development, you will want to run the script ./test/

Note: The script will stop and remove a docker container named mattermost-preview.

Note: The tests can only be run once against a given Mattermost instance. This is because the scripts currently assume they can create an initial admin user.

Note: The scripts assume the instance is reachable on localhost:8065 over plain HTTP.

For use in production we use TLS, but for testing purposes we avoid the certificate setup.

Our Versioning Scheme

This library uses the same versioning scheme as matterhorn, see Our Versioning Scheme. The short version is that in ABBCC.X.Y, the ABBCC corresponds to Mattermost server version A.BB.CC and the X.Y portion of the version string corresponds to the version of mattermost-api package releases.