Skip to main content

Cyware Orchestrate

Mattermost

App Vendor: Mattermost

App Category: IT Services, Messaging

Connector Version: 1.0.0

API Version: V4

About App

Mattermost is an open source, enterprise team collaboration and messaging platform that can be used to communicate and collaborate any time, any where. It can be deployed on-premise or on cloud infrastructure that gives you the controls you need and when you need them.

The Mattermost app is configured with the Orchestrate application to perform the following actions:

Action Name

Description

Get a list of Users

This action retrieves a list of users using query params from the Mattermost rest API application.

Get User Details

This action retrieves details about a particular user using user UID from the Mattermost rest API application.

Get a list of Teams

This action retrieves a list of teams using query params from the Mattermost rest API application.

Get Team Details

This action retrieves details about a particular team using team ID from the Mattermost rest API application.

Get a list of Channels

This action retrieves a list of channels using query params from the Mattermost rest API application.

Get Channel Details

This action retrieves details about a particular channel using channel ID from the Mattermost rest API application.

Get a list of Groups

This action retrieves a list of groups using query params from the Mattermost rest API application.

Get Group Details

This action retrieves details about a particular group using group ID from the Mattermost rest API application.

Upload File in Channel

This action uploads a file in channel using channel ID, filename, filepath and client IDs in the Mattermost rest API application.

Get File Public Link

This action retrieves the file public link for view|download using file ID from the Mattermost rest API application.

Get a list of Channel Posts

This action retrieves a list of posts from channel using channel ID and query params from the Mattermost rest API application.

Get File info from Post

This action retrieves information about a file from the particular post using post ID from the Mattermost rest API application.

Get Threads from Post

This action retrieves a list of threads from particular post using post ID from the Mattermost rest API application.

Get Post Details

This action retrieves a post using the post ID from the Mattermost rest API application.

Create Post in Channel

This action creates a post in particular channel using channel ID, message and extra variables in the Mattermost rest API application.

Configuration Parameters

The following configuration parameters are required for the Mattermost app to communicate with the Mattermost enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Cloud Domain

Enter the Mattermost server FQDN.

Example:

<http|https://<server_ip|domain.tld<:port>

Text

Required

Access Token

Enter the Mattermost user access token.

Password

Required

Verify

Check if the SSL verification is needed.

Boolean

Optional

Allowed values:

  • True

  • False

Default value:

False

Action: Get a list of Users

This action retrieves a list of users using the query parameters from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query params

Enter the query parameters as Key Value pairs.

Key Value

Optional

Allowed values:

  • page(int, default:0)

  • per_page(int, default:60, max:200)

  • in_team(str): id of team

  • not_in_team(str): id of team

  • in_channel(str): id of channel

  • not_in_channel(str): id of channel

  • in_group(str): id of group

  • group_constrained(bool)

  • without_team(bool)

  • active(bool)

  • inactive(bool)

  • role(str)

  • sort(str): in_team, in_channel

  • roles(comma separated string)

  • channel_roles(comma separated string)

  • team_roles(comma separated string)

Action: Get User Details

This action retrieves details about a particular user using user UID from the Mattermost rest api application

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

User ID

Enter the user ID.

Text

Required

Action: Get a list of Teams

This action retrieves a list of teams using query params from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query params

Enter the query parameters as Key Value pairs.

Key Value

Optional

Allowed values:

  • page(int, default:0)

  • per_page(int, default:60, max:200)

  • include_total_count(bool, default:false)

Action: Get Team Details

This action retrieves details about a particular team using team ID from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Team ID

Enter the team ID.

Text

Required

Action: Get a list of Channels

This action retrieves a list of channels using query params from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query params

Enter the query params as Key Value pairs.

Key Value

Optional

Allowed values:

  • not_associated_to_group(str): group guid

  • page(int, default:0)

  • per_page(int, default:60, max:200)

  • exclude_default_channels(bool, default:false)

Action: Get Channel Details

This action retrieves details about a particular channel using channel ID from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Channel ID

Enter the channel ID.

Text

Required

Action: Get a list of Groups

This action retrieves a list of groups using query params from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query params

Enter the query parameters as Key Value pairs.

Key Value

Optional

Allowed values

  • page(int, default:0)

  • per_page(int, default:60, max:200)

  • q(str)

  • include_member_count(bool)

  • not_associated_to_team(required, str): team guid

  • not_associated_to_channel(required, str): group guid

  • since(int): unix timestamp (in milliseconds)

Action: Get Group Details

This action retrieves details about a particular group using group id from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Group ID

Enter the group ID.

Text

Required

Action: Upload File in Channel

This action uploads a file in channel using channel id, filename, filepath and client IDs in the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Channel ID

Enter the channel ID.

Text

Required

Filename

Enter the filename with or without extensions.

Text

Required

Filepath

Enter the local filepath.

Text

Required

Client ids

Enter the client IDs (comma-separated string)

Text

Optional

Action: Get File Public Link

This action retrieves the file public link for view|download using file ID from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

File ID

Enter the file ID.

Text

Required

Action: Get a List of Channel Posts

This action retrieves a list of posts from channel using channel ID and query params from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Channel ID

Enter the channel ID.

Text

Required

Query params

Enter the query params as Key Value pairs.

Key Value

Optional

Allowed values:

  • page(int, default:0)

  • per_page(int, default:60, max:200)

  • since(int): unix timestamp milliseconds

  • before(str): post ID

  • after(str): post ID

Action: Get Channel Details

This action retrieves details about a particular channel using channel ID from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Channel ID

Enter the channel ID.

Text

Required

Action: Get a list of Groups

This action retrieves a list of groups using query params from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Query params

Enter the query parameters as Key Value pairs.

Key Value

Optional

Allowed values

  • page(int, default:0)

  • per_page(int, default:60, max:200)

  • q(str)

  • include_member_count(bool)

  • not_associated_to_team(required, str): team guid

  • not_associated_to_channel(required, str): group guid

  • since(int): unix timestamp (in milliseconds)

Action: Get Group Details

This action retrieves details about a particular group using group id from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Group ID

Enter the group ID.

Text

Required

Action: Upload File in Channel

This action uploads a file in channel using channel id, filename, filepath and client IDs in the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Channel ID

Enter the channel ID.

Text

Required

Filename

Enter the filename with or without extensions.

Text

Required

Filepath

Enter the local filepath.

Text

Required

Client ids

Enter the client IDs (comma-separated string)

Text

Optional

Action: Get File Public Link

This action retrieves the file public link for view|download using file ID from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

File ID

Enter the file ID.

Text

Required

Action: Get a List of Channel Posts

This action retrieves a list of posts from channel using channel ID and query params from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Channel ID

Enter the channel ID.

Text

Required

Query params

Enter the query params as Key Value pairs.

Key Value

Optional

Allowed values:

  • page(int, default:0)

  • per_page(int, default:60, max:200)

  • since(int): unix timestamp milliseconds

  • before(str): post ID

  • after(str): post ID

Action: Get File info from Post

This action retrieves information about a file from the particular post using post ID from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Post ID

Enter the post ID.

Text

Required

Action: Get Threads from Post

This action retrieves a list of threads from particular post using post id from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Post ID

Enter the post ID.

Text

Required

Action: Get Post Details

This action retrieves a post using the post ID from the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Post ID

Enter the post ID.

Text

Required

Action: Create Post in Channel

This action creates a post in particular channel using channel ID, message and extra variables in the Mattermost rest API application.

Action Input Parameters

Parameter

Description

Field Type

Required/Optional

Comments

Channel ID

Enter the channel ID.

Text

Required

Message

Enter the message.

Text

Required

Extra variables

Enter the extra variables as key-value pairs.

Key Value

Optional

Allowed values:

  • root_id(str): post ID to comment on

  • file_ids(array of strings): a list of file IDs, max:5

  • props(obj): a general json property bag to attach to the post

Set online

Choose if you want to set user status as online or not.

Boolean

Optional

Allowed values:

  • True

  • False

Default value:

False