Skip to content

Mattermost

URL Format

mattermost://[username@]mattermost-host/token[/channel][?icon=smiley&disabletls=yes]

URL Fields

  • UserName - Override webhook user
    Default: empty
    URL part: mattermost://username@host:port/token/channel

  • Host - Mattermost server host (Required)
    URL part: mattermost://username@host:port/token/channel

  • Token - Webhook token (Required)
    URL part: mattermost://username@host:port/token/channel

  • Channel - Override webhook channel
    Default: empty
    URL part: mattermost://username@host:port/token/channel

Query/Param Props

Props can be supplied through URL query params: ?key=value&key=value etc.

  • DisableTLS
    Default: ❌ No

  • Icon - Use emoji or URL as icon (based on presence of http(s)😕/ prefix)
    Default: empty
    Aliases: icon_emoji, icon_url

Creating a Webhook in MatterMost

  1. Open up the Integrations page by clicking on Integrations within the menu
Screenshot 1: Open up the Integrations page
  1. Click Incoming Webhooks
Screenshot 2: Click on Incoming Webhooks
  1. Click Add Incoming Webhook
Screenshot 3: Click on Add Incoming Webhook
  1. Fill in the information for the webhook and click Save
Screenshot 4: Fill in the information for the webhook and click _Save_
  1. If you did everything correctly, MatterMost will give you the URL to your newly created webhook
Screenshot 5: If you did everything correctly, MatterMost will give you the _URL_ to your newly created webhook
  1. Format the service URL
https://your-domain.com/hooks/bywsw8zt5jgpte3nm65qjiru6h
                              └────────────────────────┘
                                        token
mattermost://your-domain.com/bywsw8zt5jgpte3nm65qjiru6h
                             └────────────────────────┘
                                       token

Additional URL configuration

Mattermost provides functionality to post as another user or to another channel, compared to the webhook configuration.

To do this, you can add a user and/or channel to the service URL.

mattermost://[email protected]/bywsw8zt5jgpte3nm65qjiru6h/shoutrrrChannel
             └──────────┘                 └────────────────────────┘ └─────────────┘
                 user                               token                channel

Released under the MIT License