Chatroom Integration Plugin (discourse-chat-integration)

Summary: Integrate your chat system of choice with Discourse

:link: GitHub: https://github.com/discourse/discourse-chat-integration
:arrow_right: Install: Follow the plugin installation guide.

Features

Continuing from Common event system for chatrooms

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

Configuration

  1. In your site settings, check chat_integration_enabled is :heavy_check_mark:
  2. Click on one of the providers below to see provider-specific setup instructions
  3. For more details, read ‘Configuring Rules’ below
Provider Notifications Slash Commands Post Transcripts Threaded Replies
Slack :white_check_mark: :white_check_mark: :white_check_mark: :white_check_mark:
Telegram :white_check_mark: :white_check_mark:
Discord :white_check_mark:
Mattermost :white_check_mark: :white_check_mark:
Google Chat :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 :white_check_mark:
Basecamp Docs
IRC Cloud Docs
Flock Docs
Webex :white_check_mark:

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 with threaded replies - notify for new posts matching this rule, create per-topic threads on the chat provider (not available in all integrations)
    • 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. (Note that at this time, only the Slack integration implements threads.)

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.

To load a transcript for a Slack thread, you can use /discourse post thread {url}, where {url} is the permalink of the first message in the thread. For example:

/discourse post thread https://<slackname>.slack.com/archives/C6029G78F/p1522952993000017

Alternatively, you can use /discourse post with a thread-specific permalink like this:

/discourse post https://foo.slack.com/archives/G49KKS6AX/p1523062012000911?thread_ts=1523091738.000088&cid=G49KKS6AC

In both cases the “first/last message” UI is skipped - the entire thread is included in the transcript.

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.

CHANGELOG

TODO

93 Likes
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 Microsoft Teams notifications using the discourse-chat-integration plugin
Set up Gitter notifications using the discourse-chat-integration plugin
Set up Zulip notifications using the discourse-chat-integration plugin
Set up CA Flowdock notifications using the discourse-chat-integration plugin
Set up Google Chat notifications using the discourse-chat-integration plugin
Set up Webex notifications using the discourse-chat-integration plugin
Telegram Notifications Plugin (discourse-telegram-notifications)
Tool for Tossing out Notifications via Discord
Moving from Slack to Discourse
Will Rocket Chat and others get transcript posting?
iOS Mobile App Notifications
Telegram Notifications Plugin (discourse-telegram-notifications)
Set up Slack notifications using the discourse-chat-integration plugin
Dynamic of community with a chat and discourse page
Steam Authentication & Integration
Discourse-official-slack: no error message after failed post to slack
Auto Post New Topics to Social Media
Configuring Slack for Discourse Slack Plugin
Set up Discord notifications using the discourse-chat-integration plugin
Comment on a question instead of answering it
Slack to Discourse
Set up Telegram integration using the discourse-chat-integration plugin
Discord chat integration for open source projects
German People here
Slack Plugin Still Active?
Help configuring Slack Discourse plugin
Optionally threading posts to parent topic in slack integration
Checking if post or thread - Ruby
Discourse & Drift Chatbot
Can Discourse Integrate with Free Slack?
Advice for getting my little game dev community "out there?"
Optionally threading posts to parent topic in slack integration
Set up Telegram integration using the discourse-chat-integration plugin
Groupme Provider Integration for discourse-chat-integration plugin
Is it possible to use live chat software with Discourse?
Feed Discourse posts into my Discord server?
Twilio - for SMS notifications to users - Anyone Else Interested?
Discourse vs Salesforce Community vs Slack
Gitter support in chat-integration appears to be missing settings and rules
Discourse for Teams is here!
Internal Onebox links cause full page reload
Federation support for Discourse
Adding a confirmation to particular tag groups and @mentions
Best chat integration for a Forum breakout
Babble - A Chat Plugin
Writing messages from Slack to Discourse
Writing messages from Slack to Discourse
Configuring Discord Login for Discourse
Adding a new provider to discourse-chat-integration
Discourse to Discord bot possible?
Discourse as a Virtual Conference Platform
Send summary of new posts to chat instead of every post update
Contributor Interviews – David Taylor
[PAID] Turning Discourse Forum to Messenger App
Set up Slack notifications using the discourse-chat-integration plugin
Yammer integration
Introducing Discourse Chat (PRE-ALPHA)
Two-way sync chat with discourse
Plugin for auto posting to social media?
Notifications integration for Facebook and Twitter
Telegram Notifications Plugin (discourse-telegram-notifications)
IFTTT Chat Integration Plugin - curious on status
HipChat Integration
Can you enable a plugin that integrates slack and discourse?
Discourse Data Explorer Query Response to Slack
Nextcloud support
Help configuring Slack Discourse plugin
Advice for starting a community site for housing cooperative
How can I beef up Discourse notifications?
More Like WhatsApp for addiction support?

Hi, I’m having some trouble with Google Chat integration. When I click on the Create Channel button, nothing happens. Chrome console sows the following:

image

2 Likes

Thanks for the report @kchang718, I’ve just fixed the issue in

If you update the plugin to the latest version, the issue should be resolved. If you’re self-hosting, visit /admin/upgrade. If you’re using a managed hosting service, you’ll need to ask them to update the plugin for you.

4 Likes

Awesome, it works. Thanks!

4 Likes

Hi,

What are the chances of updating/adding a rule filter to send notifications when a topic has a first post and when the first post is edited?

I’m currently using it for sharing information on event times/dates, but of course sometimes things change and then there’s no indication in the channel that anything has. I don’t expect the plugin to go back and edit a post it’s already sent, but it would be nice if we could at least post with the new information so users know to only refer to the latest post sent.

2 Likes

Hi

Is it possible to filter out auto-generated section links while posting a topic on slack?

Here’s a recent sample:

Discourse Forum APP 21:04

FirstName LastName @username

Topic Title (Nov 29, 2021)

https://forum.example.com#agenda-1Agenda

text…

https://forum.example.com#to-bring-up-2To bring up

text…

https://forum.example.com#notes-3Notes

text…

1 Like