> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/mattermost.md).

# Mattermost

Connect to a Mattermost server with an access token to read channels and posts, send messages, and upload files.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| Mattermost | Credentials    |

#### Mattermost

Connect to a Mattermost server with an access token to read channels and posts, send messages, and upload files.

**Set up in Mattermost**

1. Prepare the Mattermost account or service that the workflow will access. Grant access to the required resources and operations.
2. **Server URL:** Base URL of your Mattermost server, e.g. <https://mattermost.example.com> (without the /api/v4 suffix). Must be reachable from the public internet.
3. **Access Token:** A Mattermost personal access token or bot access token. Create one under Account Settings > Security > Personal Access Tokens (an admin must enable them).

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Mattermost**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                                                     |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Server URL    | Yes      | Base URL of your Mattermost server, e.g. <https://mattermost.example.com> (without the /api/v4 suffix). Must be reachable from the public internet.                                                                                                               |
| Access Token  | Yes      | A Mattermost personal access token or bot access token. Create one under Account Settings > Security > Personal Access Tokens (an admin must enable them). [Provider instructions](https://developers.mattermost.com/integrate/reference/personal-access-token/). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Mattermost** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Post

Post a message to a Mattermost channel.

**Inputs**

| Field                   | Type     | Required | Description                                                        |
| ----------------------- | -------- | -------- | ------------------------------------------------------------------ |
| Channel ID              | string   | Yes      | The channel to post in.                                            |
| Message                 | textarea | Yes      | The message text (Markdown supported).                             |
| Reply To (Root Post ID) | string   | No       | Post ID to reply to; leave blank to start a new thread. Default: . |
| File IDs                | array    | No       | IDs of previously uploaded files to attach.                        |

**Outputs**

| Field   | Type   | Description                 |
| ------- | ------ | --------------------------- |
| Post    | object | The created post.           |
| Post ID | string | The ID of the created post. |

#### Create Channel

Create a public or private channel in a Mattermost team.

**Inputs**

| Field          | Type            | Required | Description                                                                              |
| -------------- | --------------- | -------- | ---------------------------------------------------------------------------------------- |
| Team ID        | string          | Yes      | The team the channel belongs to.                                                         |
| Channel Handle | string          | Yes      | The URL-safe channel handle (lowercase, no spaces).                                      |
| Display Name   | string          | Yes      | The human-readable channel name shown in the UI.                                         |
| Channel Type   | select (string) | No       | Whether the channel is public or private. Available values: Public, Private. Default: O. |

**Outputs**

| Field      | Type   | Description                    |
| ---------- | ------ | ------------------------------ |
| Channel    | object | The created channel.           |
| Channel ID | string | The ID of the created channel. |

#### Get Channel Posts

Read recent posts from a Mattermost channel.

**Inputs**

| Field      | Type    | Required | Description                                      |
| ---------- | ------- | -------- | ------------------------------------------------ |
| Channel ID | string  | Yes      | The channel to read posts from.                  |
| Page       | integer | No       | Zero-based page number. Default: 0.              |
| Per Page   | integer | No       | Number of posts per page (max 200). Default: 60. |

**Outputs**

| Field | Type    | Description                             |
| ----- | ------- | --------------------------------------- |
| Posts | array   | The posts in the channel, newest first. |
| Count | integer | The number of posts returned.           |

#### Create Direct Channel

Open a direct-message channel between two Mattermost users.

**Inputs**

| Field          | Type   | Required | Description                                 |
| -------------- | ------ | -------- | ------------------------------------------- |
| First User ID  | string | Yes      | One of the two users in the direct message. |
| Second User ID | string | Yes      | The other user in the direct message.       |

**Outputs**

| Field      | Type   | Description                           |
| ---------- | ------ | ------------------------------------- |
| Channel    | object | The direct-message channel.           |
| Channel ID | string | The ID of the direct-message channel. |

#### Upload File

Upload a file to a Mattermost channel.

**Inputs**

| Field      | Type   | Required | Description                                          |
| ---------- | ------ | -------- | ---------------------------------------------------- |
| Channel ID | string | Yes      | The channel to upload the file to.                   |
| File       | file   | Yes      | The file to upload.                                  |
| File Name  | string | No       | Override the stored file name (optional). Default: . |

**Outputs**

| Field   | Type   | Description                   |
| ------- | ------ | ----------------------------- |
| File    | object | The uploaded file's metadata. |
| File ID | string | The uploaded file's ID.       |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/mattermost.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
