skip to navigation
skip to content

mattermostdriver-asyncio 5.0.1

An asyncio Python Mattermost Driver

Python Mattermost Driver (now with asyncio!)(APIv4)


The repository will try to keep up with the master of

If something changes, it is most likely to change because the official mattermost api changed.


pip install mattermostdriver-asyncio


Documentation can be found at .


from mattermostdriver import Driver

foo = Driver({
    # Required options
    'url': '',
    'login_id': '',
    'password': 'verySecret',
    # Instead of login/password you can also use a personal access token
    'token': 'YourPersonalAccessToken',
    # Optional / defaults to
    'scheme': 'https',
    'port': 8065,
    'basepath': '/api/v4',
    # Use False if self signed/insecure certificate
    'verify': True,
    # The interval the websocket will ping the server to keep the connection alive
    'timeout': 30,
    'mfa_token': 'YourMFAToken'

# Most of the requests need you to be logged in, so calling login()
# should be the first thing you do after you created your Driver instance.
# login() returns the raw response
# If using a personal access token, you still need to run login().
# In this case, does not make a login request, but a `get_user('me')`
# and sets everything up in the client.
await foo.login()

# You can make api calls by using calling `Driver.endpointofchoice`.
# Using api[''] is deprecated for 5.0.0!
# So, for example, if you used `Driver.api['users'].get_user('me')` before,
# you now just do `Driver.users.get_user('me')`.
# The names of the endpoints and requests are almost identical to
# the names on the page.
# API calls always return the json the server send as a response.
await foo.users.get_user_by_username('')

# If the api request needs additional parameters
# you can pass them to the function in the following way:
# - Path parameters are always simple parameters you pass to the function
await foo.users.get_user(user_id='me')

# - Query parameters are always passed by passing a `params` dict to the function
await foo.teams.get_teams(params={...})

# - Request Bodies are always passed by passing an `options` dict or array to the function
await foo.channels.create_channel(options={...})

# See the mattermost api documentation to see which parameters you need to pass.
await foo.channels.create_channel(options={
    'team_id': 'some_team_id',
    'name': 'awesome-channel',
    'display_name': 'awesome channel',
    'type': 'O'

# If you want to make a websocket connection to the mattermost server
# you can call the init_websocket method, passing an event_handler.
# Every Websocket event send by mattermost will be send to that event_handler.
# See the API documentation for which events are available.
async def event_handler(message):

await foo.init_websocket(event_handler)

# To upload a file you will need to pass a `files` dictionary
channel_id = foo.channels.get_channel_by_name_and_team_name('team', 'channel')['id']
await file_id = foo.files.upload_file(
            files={'files': (filename, open(filename))})['file_infos'][0]['id']

# track the file id and pass it in `create_post` options, to attach the file
await foo.posts.create_post(options={
    'channel_id': channel_id,
    'message': 'This is the important file',
    'file_ids': [file_id]})
# If needed, you can make custom requests by calling `make_request`
await foo.client.make_request('post', '/endpoint', options=None, params=None, data=None, files=None, basepath=None)
# If you want to call a webhook/execute it use the `call_webhook` method.
# This method does not exist on the mattermost api AFAIK, I added it for ease of use.
await foo.hooks.call_webhook('myHookId', options) # Options are optional

Available endpoints:

  • base
  • brand
  • channels
  • cluster
  • commands
  • compliance
  • elasticsearch
  • emoji
  • files
  • ldap
  • oauth
  • posts
  • preferences
  • saml
  • system
  • teams
  • users
  • webhooks
  • data_retention

See to see which api requests are available.

File Type Py Version Uploaded on Size
mattermostdriver-asyncio-5.0.1.tar.gz (md5) Source 2017-12-07 15KB
mattermostdriver_asyncio-5.0.1-py3-none-any.whl (md5) Python Wheel 3.6 2017-12-07 21KB