Skip to contents

Authentication

Authenticate with the Mattermost API and manage credentials.

authenticate_mattermost()
Authenticate with Mattermost API
clear_mattermost_credentials()
Clear cached Mattermost credentials from R options
print(<mattermost_auth>)
Print a mattermost_auth object
check_mattermost_auth()
Check if the object is a valid mattermost_auth object

Messaging

Send, edit, and delete messages. Includes webhook and thread support.

send_mattermost_message()
Send a Message to a Mattermost Channel with Optional Attachments
send_webhook_message()
Send a Message via a Mattermost Incoming Webhook
update_post()
Update (Patch) an Existing Mattermost Post
delete_post()
Delete a specific post in Mattermost
delete_old_messages()
Delete Messages Older Than X Days in a Mattermost Channel

Retrieve and search posts in channels.

get_channel_posts()
Get posts from a Mattermost channel
search_posts()
Search for posts in Mattermost

Reactions & Pins

Add emoji reactions and pin posts.

add_reaction()
Add a Reaction to a Mattermost Post
get_reactions()
Get All Reactions on a Mattermost Post
remove_reaction()
Remove a Reaction from a Mattermost Post
pin_post()
Pin a post to its channel
unpin_post()
Unpin a post from its channel

Channels

Create, manage, and query channels and their members.

create_channel()
Create a new Mattermost channel
create_direct_channel()
Create a Direct Message or Group Message Channel
delete_channel()
Delete a Mattermost channel
get_channel_info()
Get information about a Mattermost channel
get_channel_id_lookup()
Get Channel ID by Display Name or Name
get_team_channels()
Get the list of channels for a team
get_channel_members()
Get members of a channel
add_user_to_channel()
Add a user to a channel
add_users_to_channel()
Add multiple users to a channel in a single API call
remove_channel_member()
Remove a user from a channel

Teams

List and retrieve teams.

get_all_teams()
List all teams in Mattermost
get_team()
Get data of a single team from its team_id

Users

Look up users and manage their status.

get_me()
Get information about which user is belonging to bearer key,
get_user()
Get information about a specific Mattermost user
get_user_info()
Get information about a specific Mattermost user
get_all_users()
Get all known Mattermost users
get_user_status()
Get user online status
set_user_status()
Set user online status

Files

Upload and download files.

get_mattermost_file()
Retrieve a file from Mattermost

Bots

Create and manage bot accounts.

create_bot()
Create a bot account
get_bot()
Get a bot account
get_bots()
List bot accounts
update_bot()
Update a bot account
disable_bot()
Disable a bot account
enable_bot()
Enable a bot account
assign_bot()
Assign a bot to a different owner

Slash Commands

Register and manage slash commands.

create_command()
Create a slash command
get_command()
Get a slash command
list_commands()
List slash commands for a team
update_command()
Update a slash command
delete_command()
Delete a slash command
execute_command()
Execute a slash command
regen_command_token()
Regenerate a command token

Low-level / Developer

Direct API access and server utilities.

mattermost_api_request()
Make a Mattermost API Request
check_mattermost_status()
Check if the Mattermost server is online