Mattermost 2.0.0
App Vendor: Mattermost
App Category: IT Services, Messaging
Connector Version: 2.0.0
API Version: API: V4
About App
The Mattermost REST API Integration app enables seamless connectivity with the Mattermost platform, an open-source, enterprise-grade team collaboration and messaging tool that can be deployed on-premises or in the cloud under your IT team's control.
The Mattermost app is configured with Cyware Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Create Post | This action creates a post in the specified channel. |
Get Channel Details | This action retrieves the details of a particular channel. |
Get Channels | This action retrieves a list of channels from Mattermost. |
Get File Info from Post | This action retrieves the file information from the specified post. |
Get Group Details | This action retrieves the details of a particular group. |
Get Groups | This action retrieves a list of groups from Mattermost. |
Get Post Details | This action retrieves the details of a particular post. |
Get Posts from a Channel | This action retrieves a list of posts from the specified channel. |
Get Public File Link | This action retrieves the public link of a given file ID. |
Get Team Details | This action retrieves the details of a particular team. |
Get Teams | This action retrieves a list of teams from Mattermost. |
Get Threads from Post | This action retrieves a list of threads from the specified post. |
Get User Details | This action retrieves the details of a particular user. |
Get Users | This action retrieves a list of users from mattermost. |
Upload File | This action uploads a file to the specified channel. |
Generic Action | This is a generic action used to make requests to any Mattermost endpoint. |
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 | Choose your preference to verify SSL or TLS while making requests. It is recommended to set this option to yes. Passing no may result in incorrectly establishing the connection. | Boolean | Optional | By default, verification is disabled. |
API Version | Enter the API version to be used. | Text | Optional | Default value: v4 |
Timeout | Enter the timeout value in seconds. This is the number of seconds that requests will wait to establish a connection with Mattermost. | Integer | Optional | Allowed range: 15-120 Default value: 15 |
Action: Create Post
This action creates a post in the specified channel.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Channel ID | Enter the channel ID to create the post in. | Text | Required | You can retrieve channel IDs using the action Get Channels. |
Message | Enter the content of the message. | Text | Required | |
Extra Params | Enter the extra parameters to create the post. | Key Value | Optional | Allowed keys: root_id, file_ids, props, metadata |
Set Online | Choose true to set the status of the user online. | Boolean | Optional | Default value: False |
Action: Get Channel Details
This action retrieves the details of a particular channel.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Channel ID | Enter the channel ID to retrieve the details. | Text | Required | You can retrieve the channel ID using the action Get Channels. |
Action: Get Channels
This action retrieves a list of channels from Mattermost.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query Params | Enter the query parameters to retrieve the list of channels. | Key Value | Optional | Allowed keys: not_associated_to_group, page, per_page, exclude_default_channels, include_deleted, include_total_count, exclude_policy_constrained |
Action: Get File Info from Post
This action retrieves the file information from the specified post.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Post ID | Enter the ID of the post to retrieve file information. | Text | Required | You can retrieve the post ID using the action Get Posts from a Channel. |
Include Deleted | Choose true to include deleted posts in the response. | Boolean | Optional | Default value: false |
Action: Get Group Details
This action retrieves the details of a particular group.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Group ID | Enter the group ID to retrieve the details. | Text | Required | You can retrieve group ID using the action Get Groups. |
Action: Get Groups
This action retrieves a list of groups from Mattermost.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query Params | Enter the query parameters to retrieve the list of groups. | Key Value | Optional | Allowed keys: page, per_page, q, include_member_count, not_associated_to_team, not_associated_to_channel, since, filter_allow_reference |
Action: Get Post Details
This action retrieves the details of a particular post.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Post ID | Enter the post ID to retrieve its details. | Text | Required | You can retrieve the post ID using the action Get Posts from a Channel. |
Include Deleted | Choose true to include deleted posts in the response. | Boolean | Optional | Default value: False |
Action: Get Posts from a Channel
This action retrieves a list of posts from the specified channel.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Channel ID | Enter the ID of the channel to retrieve the posts from. | Text | Required | You can retrieve the channel ID using the action Get Channels. |
Query Params | Enter the query parameters to retrieve the posts. | Key Value | Optional | Allowed keys: page, per_page, since, before, after, include_deleted |
Action: Get Public File Link
This action retrieves the public link of a given file ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
File ID | Enter the ID of the file to retrieve its public link. | Text | Required | You can retrieve the file ID using the action Get File Info from Post. |
Action: Get Team Details
This action retrieves the details of a particular team.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Team ID | Enter the team ID to retrieve its details. | Text | Required | You can retrieve the team ID using the action Get Teams. |
Action: Get Teams
This action retrieves a list of teams from Mattermost.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query Params | Enter the query parameters to retrieve the list of teams. | Key Value | Optional | Allowed keys: page, per_page, include_total_count, exclude_policy_constrained |
Action: Get Threads from Post
This action retrieves a list of threads from the specified post.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Post ID | Enter the ID of the post to retrieve the threads from. | Text | Required | You can retrieve the post ID using the action Get Posts from a Channel. |
Query Params | Enter the query parameters to retrieve the threads from. | Key Value | Optional | Allowed keys: perPage, fromPost, fromCreateAt, direction, skipFetchThreads, collapsedThreads, collapsedThreadsExtended |
Action: Get User Details
This action retrieves the details of a particular user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to retrieve the details. | Text | Required | You can retrieve the user ID using the action Get Users. |
Action: Get Users
This action retrieves a list of users from Mattermost.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Query Params | Enter the query parameters to retrieve the list of users. | Key Value | Optional | Allowed keys: page, per_page, in_team, not_in_team, in_channel, not_in_channel, in_group, group_constrained, without_team, active, inactive, role, sort, roles, channel_roles, team_roles |
Action: Upload File
This action uploads a file to the specified channel.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Channel ID | Enter the ID of the channel where you want to upload the file. | Text | Required | You can retrieve the channel ID using the action Get Channels. |
Filename | Enter the name of the file to upload. | Text | Required | |
File Path | Enter the path of the file which you want to upload. | Text | Required | |
Client IDs | Enter the comma-separated client IDs. | Text | Optional |
Action: Generic Action
This is a generic action used to make requests to any Mattermost endpoint.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Method | Enter the HTTP method to make the request. | Text | Required | Allowed values: GET, PUT, POST, DELETE |
Endpoint | Enter the endpoint to make the request to. Example: groups | Text | Required | |
Query Params | Enter the query parameters to pass to the API. | Key Value | Optional | |
Payload | Enter the payload to pass to the API. | Any | Optional | |
Extra Fields | Enter the extra fields to pass to the API. | Key Value | Optional | Allowed keys: payload_json, custom_output, download, files, filename, retry_wait, retry_count, response_type |