Chatroom Integration Plugin (discourse-chat-integration)

official

(David Taylor) #1

Continuing from Common event system for chatrooms

:speech_balloon: discourse-chat-integration :speech_balloon:

discourse-chat-integration is the product of my Google Summer of Code project with Discourse. It allows sending notifications about new Discourse posts to ‘group chats’ on a number of instant messaging platforms.

It is based on, and aims to supersede, the existing discourse-slack-official plugin.

Notifications can be triggered by new topics, new replies, messages to a group, or mentions of a group. A notification in your instant messaging system will look something like this:

16

Getting Started

  1. Install the plugin by following the Install Plugin instructions. The plugin’s repository address is
    https://github.com/discourse/discourse-chat-integration.git
    
  2. In your site settings, check chat_integration_enabled is :heavy_check_mark:
  3. Click on one of the providers below to see provider-specific setup instructions
  4. For more details, read ‘Configuring Rules’ below
Provider Notifications Slash Commands Post Transcripts
Slack :white_check_mark: :white_check_mark: :white_check_mark:
Telegram :white_check_mark: :white_check_mark:
Discord :white_check_mark:
HipChat :white_check_mark:
Mattermost :white_check_mark: :white_check_mark:
Matrix (riot.im) :white_check_mark:
Zulip :white_check_mark:
Rocket.Chat :white_check_mark:
Gitter :white_check_mark:
Flowdock :white_check_mark:
Stride Docs
Microsoft Teams Docs
Basecamp Docs
IRC Cloud Docs
Flock Docs

Terminology

There are three key concepts in discourse-chat-integration: Providers, Channels and Rules

Configuring Rules

In your forum’s admin panel, under Plugins, you should see a Chat Integrations section. Within that there will be tabs for each of your enabled providers:

Rules have a number of options which can be configured:

  • Type:
    • Normal - send notifications based on standard posts on the forum
    • Group Message - send notifications based on private messages which a specified group is a part of
    • Group Mention - send notifications whenever specified group is @mentioned in a standard post on the forum (mentions in private messages are ignored)
  • Filter:
    • All posts and replies - notify for new posts matching this rule
    • First post only - notify only for new topics matching this rule
    • Mute - prevent notifications matching this rule
  • Category (if type is ‘Normal’)
    • Match posts based on their category. Leave as “(all categories)” to match all posts on the forum
  • Group (if type is ‘Group Message’ or ‘Group Mention’)
    • Specify the group you want to receive notifications for
  • Tags
    • Enter a list of tags to match posts with at least one of the listed tags. Leave blank to match all posts

Multiple rules

When multiple rules match a post, the top-most rule in the user interface is executed. Rules are first sorted according to the criteria:

  1. Group mentions
  2. Group messages
  3. Normal

and then sorted within that by

  1. Mute
  2. All posts and replies
  3. First post only

For example, with the following rules

Filter Category Tags
All posts and replies Mentions of: @team (all tags)
Mute #support (all tags)
First post only #support #unsupported-install
All posts and replies (all categories) (all tags)

Notifications would be triggered for

but not for

Security/Permissions

The site setting “chat integration discourse username” allows you to secure your notifications against leaking private information.

By default the system account is used, which means that there is no restriction on notifications sent. To secure your notifications you should create a non-staff user with appropriate access privileges, and enter its username in the site setting.

Slash Commands

If your provider supports slash commands, you can manage rules from within your chat interface. Each provider varies slightly in syntax, but in general they follow a similar structure.

The commands available are

Posting a transcript

If your provider supports transcript posting, you can post your instant messaging history to discourse. This is currently only supported for the Slack provider. Note: You will need to be using the “Access Token” method of connecting to Slack.

Send /discourse post to see the interface. The plugin will try and “guess” where your current conversation starts, by looking for a gap in the message history of more than 3 minutes.

Alternatively, you can specify a number of posts after the command, or a URL to the first message.

Adding new providers

Option 1: Submit a PR implementing your provider:

Option 2: Use your own plugin:
It is possible for third party plugins to register new “providers”. As an example, I’ve created a provider which sends webhooks to IFTTT. This could be used to automatically publish all posts in a category to facebook… or turn on your light when someone posts in #feature… or feed your fish whenever there’s a new #plugin.


Set up Slack notifications using the discourse-chat-integration plugin
Set up Mattermost notifications using the discourse-chat-integration plugin
Set up Rocket Chat notifications using the discourse-chat-integration plugin
Set up Matrix (riot.im) notifications using the discourse-chat-integration plugin
Set up HipChat notifications using the discourse-chat-integration plugin
Set up Gitter notifications using the discourse-chat-integration plugin
Set up CA Flowdock notifications using the discourse-chat-integration plugin
Set up Zulip notifications using the discourse-chat-integration plugin
Telegram Notifications Plugin (discourse-telegram-notifications)
Telegram Notifications Plugin (discourse-telegram-notifications)
Steam Authentication & Integration
[Deprecated] The Official Discourse Slack Plugin
Chat client suggestions?
[Deprecated] The Official Discourse Slack Plugin
Internal Onebox links cause full page reload
Will Rocket Chat and others get transcript posting?
Writing messages from Slack to Discourse
Writing messages from Slack to Discourse
Can you enable a plugin that integrates slack and discourse?
Plugin for auto posting to social media?
Telegram Notifications Plugin (discourse-telegram-notifications)
Tool for Tossing out Notifications via Discord
Chat Integration leaks Babble chats
Contributor Interviews – David Taylor
iOS Mobile App Notifications
Recommended chat platform for Discourse
Notifications integration for Facebook and Twitter
Send summary of new posts to chat instead of every post update
Auto Post New Topics to Social Media
HipChat Integration
Dynamic of community with a chat and discourse page
Adding a new provider to discourse-chat-integration
Discourse-official-slack: no error message after failed post to slack
Help configuring Slack Discourse plugin
Set up Slack notifications using the discourse-chat-integration plugin
Does Discourse have a chat room function?
About the chat-integration category
Configuring Slack for Discourse Slack Plugin
(Erlend Sogge Heggen) #2

112 posts were split to a new topic: Chatroom Integration - Legacy replies


#13

A post was split to a new topic: Notifications via Facebook


(Erlend Sogge Heggen) #106

A post was split to a new topic: Recommended chat platform for Discourse


(Erlend Sogge Heggen) #107

2 posts were split to a new topic: Notifications integration for Facebook and Twitter


(Erlend Sogge Heggen) #129

2 posts were split to a new topic: Username on Slack is not transferred correctly in transcript export


(Erlend Sogge Heggen) #130

Please post replies to the #plugin:chat-integration category.