Understanding Incoming Webhooks vs REST API (Bot accounts) in Mattermost

Understanding Incoming Webhooks vs REST API in Mattermost (using a bot account)

When integrating with Mattermost, you have two main options for sending messages: Incoming Webhooks and the REST API. Both are useful for posting messages, but they have different purposes and features. Here's a quick breakdown of each :

1. Incoming Webhooks: Simple and Efficient

Incoming Webhooks are a quick and easy way to send messages to Mattermost. They allow you to send plain text messages and rich formatted content into Mattermost channels. Here’s how they work:

• Easy Setup: You can create a webhook URL from the Mattermost platform, and use that URL in your integration.

• Limited Use: They are best for basic tasks, like sending messages with simple text or content that doesn’t require advanced logic or file handling.

• Attachments: You can use attachments to make messages more engaging. For example, you can include images, formatting, and even interactive buttons.

• No File Uploads: Webhooks do not support uploading files such as PDFs, DOCs, images, etc. They are only for sending text and formatted content (attachments).

When to use Webhooks:

• You need a simple integration.

• You only need to send messages with basic formatting and content.

• You don’t need to upload files or perform complex actions.

What Are Attachments?

When “attachments” are mentioned in Mattermost integrations documentation, it refers to Slack’s message attachments functionality. These “attachments” can be optionally added as an array in the data sent by an integration, and are used to customize the formatting of the message.

Mattermost doesn’t currently support the ability to attach files to a post made via webhook. You can use the API to attach files to a message if needed.

2. REST API: Advanced Capabilities

The REST API provides a more powerful and flexible approach for interacting with Mattermost. It gives you full control over creating, managing, and manipulating messages and channels. Here’s how the REST API works:

• Advanced Features: It allows for more complex tasks like uploading files, posting messages with attachments, managing channels, and more.

• More Setup Required: You need to set up API tokens, handle authentication, and use HTTP methods (like POST, GET) to interact with the Mattermost server.

• File Uploads: Unlike webhooks, the REST API allows you to upload files such as PDFs, DOCs, and images.

• Rich Features: You can manage channels, users, and posts programmatically, which offers more flexibility for creating custom integrations.

When to use the REST API:

• You need to upload files, such as images or documents.

• You want to automate complex processes or interactions with Mattermost.

• You need complete control over message delivery, user management, or channel operations.