BigW Consortium Gitlab

mattermost_service.rb 1.15 KB
Newer Older
1
class MattermostService < ChatNotificationService
2 3 4 5 6 7 8 9
  def title
    'Mattermost notifications'
  end

  def description
    'Receive event notifications in Mattermost'
  end

10
  def self.to_param
11
    'mattermost'
12 13 14 15 16 17
  end

  def help
    'This service sends notifications about projects events to Mattermost channels.<br />
    To set up this service:
    <ol>
18 19 20 21
      <li><a href="https://docs.mattermost.com/developer/webhooks-incoming.html#enabling-incoming-webhooks">Enable incoming webhooks</a> in your Mattermost installation.</li>
      <li><a href="https://docs.mattermost.com/developer/webhooks-incoming.html#creating-integrations-using-incoming-webhooks">Add an incoming webhook</a> in your Mattermost team. The default channel can be overridden for each event.</li>
      <li>Paste the webhook <strong>URL</strong> into the field below.</li>
      <li>Select events below to enable notifications. The <strong>Channel handle</strong> and <strong>Username</strong> fields are optional.</li>
22 23 24
    </ol>'
  end

25
  def default_channel_placeholder
26
    "Channel handle (e.g. town-square)"
27
  end
28 29 30 31

  def webhook_placeholder
    'http://mattermost.example.com/hooks/…'
  end
32
end