Outgoing Webhooks

Note

This is the admin documentation for outgoing webhooks. If you’re a developer looking to build an integration, see our developer documentation.

Mattermost supports webhooks to easily integrate external applications into the server.

Use outgoing webhooks to post automated responses to posts made by your users. Outgoing webhooks will send an HTTP POST request to a web service and process a response back to Mattermost when a message matches one or both of the following conditions:

  • It is posted in a specified channel
  • The first word matches or starts with one of the defined trigger words, such as gif

Outgoing webhooks are supported in public channels only. If you need a trigger that works in a private channel or a direct message, consider using a slash command instead.

Note

To prevent malicious users from trying to perform phishing attacks a BOT indicator appears next to posts coming from webhooks regardless of what username is specified.

Create an Outgoing Webhook

Suppose you want to write an external application, which executes software tests after someone posts a message starting with the word #build in the town-square channel.

You can follow these general guidelines to set up a Mattermost outgoing webhook for your application.

1 - First, go to Main Menu > Integrations > Outgoing Webhook. If you don’t have the Integrations option in your Main Menu, outgoing webhooks may not be enabled on your Mattermost server or may be disabled for non-admins. Enable them from System Console > Integrations > Custom Integrations in prior versions or System Console > Integrations > Integration Management in versions after 5.12 or ask your System Administrator to do so.

2 - Click Add Outgoing Webhook and add name and description for the webhook. The description can be up to 500 characters.

3 - Choose the content type by which the request will be sent.

  • If application/x-www-form-urlencoded is chosen, the server will encode the parameters in a URL format in the request body.
  • If application/json is chosen, the server will format the request body as JSON.

4 - Select the public channel to receive webhook responses, or specify one or more trigger words that send an HTTP POST request to your application. You may configure either the channel or the trigger words for the outgoing webhook, or both. If both are specified, then the message must match both values.

In our example, we would set the channel to town-square and specify #build as the trigger word.

Note

If you leave the channel field blank, the webhook will respond to trigger words in all public channels of your team.

Similarly, if you don’t specify trigger words, then the webhook will respond to all messages in the selected public channel.

5 - If you specified one or more trigger words on the previous step, choose when to trigger the outgoing webhook.

  • If the first word of a message matches one of the trigger words exactly, or
  • If the first word of a message starts with one of the trigger words.

6 - Finally, set one or more callback URLs that HTTP POST requests will be sent to, and hit Save. If the URL is private, add it as a trusted internal connection.

7 - On the next page, copy the Token value. This will be used in a later step.

../_images/outgoing_webhooks_token.png

8 - Next, write your external application. Include a function, which receives HTTP POST requests from Mattermost. The function should look something like this:

Content-Length: 244
User-Agent: Go 1.1 package http
Host: localhost:5000
Accept: application/json
Content-Type: application/x-www-form-urlencoded

channel_id=hawos4dqtby53pd64o4a4cmeoo&
channel_name=town-square&
team_domain=someteam&
team_id=kwoknj9nwpypzgzy78wkw516qe&
post_id=axdygg1957njfe5pu38saikdho&
text=some+text+here&
timestamp=1445532266&
token=zmigewsanbbsdf59xnmduzypjc&
trigger_word=some&
user_id=rnina9994bde8mua79zqcg5hmo&
user_name=somename

If your integration sends back a JSON response, make sure it returns the application/json content-type.

9 - Add a configurable MATTERMOST_TOKEN variable to your application and set it to the Token value from step 7. This value will be used by your application to confirm the HTTP POST request came from Mattermost.

10 - To have your application post a message back to town-square, it can respond to the HTTP POST request with a JSON response such as:

{"text": "
| Component  | Tests Run   | Tests Failed                                   |
|:-----------|:------------|:-----------------------------------------------|
| Server     | 948         | :white_check_mark: 0                           |
| Web Client | 123         | :warning: [2 (see details)](http://linktologs) |
| iOS Client | 78          | :warning: [3 (see details)](http://linktologs) |
"}

which would render in Mattermost as:

../_images/webhooksTable.PNG

11 - You’re all set! See developer documentation for details on what parameters are supported by outgoing webhooks. For instance, you can override the username and profile picture the messages post as, or specify a custom post type when sending a webhook message for use by plugins.

Messages with advanced formatting can be created by including an attachment array and interactive message buttons in the JSON payload.

Note

Enable integrations to override usernames must be set to true in config.json to override usernames. Enable them from System Console > Integrations > Custom Integrations in prior versions or System Console > Integrations > Integration Management in versions after 5.12 or ask your System Administrator. If not enabled, the username is set to webhook.

Similarly, Enable integrations to override profile picture icons must be set to true in config.json to override usernames. Enable them from System Console > Integrations > Custom Integrations in prior versions or System Console > Integrations > Integration Management in versions after 5.12 or ask your System Administrator. If not enabled, the icon of the creator of the webhook URL is used to post messages.

Tips and Best Practices

  1. Webhooks are designed to easily allow you to post messages. For other actions such as channel creation, you must also use the Mattermost APIs.
  2. If the text in the JSON response is longer than the allowable character limit per post, the message is split into multiple consecutive posts, each within the character limit. Servers running Mattermost Server v5.0 or later can support posts up to 16383 characters.
  3. Outgoing webhooks are supported in public channels only. If you need a trigger that works in a private channel or a direct message, consider using a slash command instead.
  4. You can restrict who can create outgoing webhooks in System Console > Integrations > Custom Integrations.
  5. Mattermost outgoing webhooks are Slack-compatible. You can copy-and-paste code used for a Slack outgoing webhook to create Mattermost integrations. Mattermost automatically translates the Slack’s proprietary JSON response format.
  6. The external application may be written in any programming language. It needs to provide a URL which reacts to the request sent by your Mattermost server, and send an HTTP POST in the required JSON format as a response.

Share Your Integration

If you’ve built an integration for Mattermost, please consider sharing your work in our app directory.

The app directory lists open source integrations developed by the Mattermost community and are available for download, customization and deployment to your private cloud or on-prem infrastructure.

Slack Compatibility

Mattermost makes it easy to migrate integrations written for Slack to Mattermost.

Translate Slack’s data format to Mattermost

Mattermost automatically translates the data coming from Slack:

  1. JSON responses written for Slack, that contain the following, are translated to Mattermost markdown and rendered equivalently to Slack:
    • <> to denote a URL link, such as {"text": "<http://www.mattermost.com/>"}
    • | within a <> to define linked text, such as {"text": "Click <http://www.mattermost.com/|here> for a link."}
    • <userid> to trigger a mention to a user, such as {"text": "<5fb5f7iw8tfrfcwssd1xmx3j7y> this is a notification."}
    • <!channel>, <!here> or <!all> to trigger a mention to a channel, such as {"text": "<!channel> this is a notification."}
  2. The HTTP POST request body sent to a web service is formatted the same as Slack’s. This means your Slack integration’s receiving function does not need change to be compatible with Mattermost.
  3. Slack attachments are supported with Slack-compatible outgoing webhooks. They also add support for mentions with <@userid> and announcement tokens (eg. <!here>) in the outgoing webhook responses.

Known Slack compatibility issues

  1. Using icon_emoji to override the username is not supported.
  2. Referencing channels using <#CHANNEL_ID> does not link to the channel.
  3. <!everyone> and <!group> are not supported.
  4. Parameters “mrkdwn”, “parse”, and “link_names” are not supported (Mattermost always converts markdown and automatically links @mentions).
  5. Bold formatting supplied as *bold* is not supported (must be done as **bold**).
  6. Advanced formatting using attachments is not yet supported.

Troubleshooting

To debug outgoing webhooks in System Console > Logs, set System Console > Logging > Enable Webhook Debugging to true and set System Console > Logging > Console Log Level to DEBUG.

My integration prints the JSON data in a Mattermost channel

Mattermost handles multiple content types for integrations, including plain text content type.

If your integration prints the JSON data instead of rendering the generated message, make sure your integration is returning the application/json content-type.