Notify - notifications for Slack, Hipchat and Gitter

moay

Hey guys,

I thought, I might help the project with a package for Slack notifications. I am going to use Flarum as forum software for an open source project where the community will be kind of a support platform. So it's important for the team to be notified about whats going on in the forum. As we use Slack as central communication platform, this is just the perfect solution.

You can find the repo here: https://github.com/moay/flarum-notify

Latest release: https://github.com/moay/flarum-notify/releases/latest

Feedback is very welcome 🙂

luceos

Absolutely something I like. How about you support more chats, I'd prefer hipchat (and gitter) as well.

antonjw

luceos moay This could also be interesting: https://telegram.org/

Messages are "heavily encrypted and can self-destruct", has an open API, is "free forever. No ads. No subscription fees."

Telegram is a non-commercial project with an aim to create a truly free messenger, without the usual caveats. This means that instead of diverting public attention with low-impact settings, we can afford to focus on the real privacy issues that exist in the modern world.

moay

Great idea. I'll look into this within the next days. Any other platforms that would be interesting?

FlarumHost

Yes, would love to see this send to a private Gitter room. Would love to see support to Olark too

moay

As far as I can see, olark doesn't provide a PHP compatible API. Gitter will work via it's REST Api, hipchat has a great package available.

Or am I missing anything?

I'm not the superpro when it comes to Node.js, but maybe there is a way to realize this behaviour via Node for olark?

FlarumHost

Yeah, as far as I'm aware, only a JS API https://www.olark.com/api They do have integration with xendesk https://www.olark.com/integrations There live chat staff is great, someone on the developer side of things will talk live with you if you ask 🙂

moay

@Toby @Franz @luceos Is there some sort of raw logo file (maybe .ai/.svg) that I could use to create proper icons for the notifications? Built one out of the logo file, but it's not perfect...

luceos

I recommend using composer to load available packages and build those integrations first. Any custom integration should have to wait. The reason is simple, Flarum is not yet out of beta, this period is great to make a stable extension and modify once changes are required to keep compatibility with future versions.

Once Flarum is stable, add up on integrations if you like.

moay

I reworked the whole thing today in order to make it work properly with HipChat and Gitter. This will work very well.

I do currently support the following events: Post (Add, Hide, Delete), Discussion (Started, Deleted). What do you think - should other events be notified to a chat? You can of course enable/disable each event in the plugin settings. ;-)

FlarumHost

Awesome! Has your Github been updated with the version that supports Gitter yet?

moay

Sorry, there was an error there... Gitter is not functional yet, I will add it tomorrow. But the structures are there... ;-)

As the plugin isn't limited to slack anymore, I created a new repo. I'll post it tomorrow - as soon as I got Gitter working.

I will have to write an API wrapper for Gitter, but that should be done quickly...

moay

Here we go. New repo is here: https://github.com/moay/flarum-notify

First release: https://github.com/moay/flarum-notify/releases/tag/0.1.0-beta.2

Let me know if it works for you. :-)

Sadly, Gitter is not that easy to do. Had to make it work over a webhook. That's okay, but I would have loved to do it more like with HipChat or Slack.

Ideas? Feedback?

luceos

I recently found notifyme check them out on packagist.

moay

They don't have a documentation yet. That's sad, because the services look really cool. But I think it'll work like this for now... ;-)

moay

Fixed two problems. One for HipChat, one for Gitter. Also added a lot of Commenting.

New release here: https://github.com/moay/flarum-notify/releases/tag/0.1.1

justshipit

I <3 you @moay ! Thank you so much as I was about to write my own solution and you just saved me time!

justshipit

@[deleted] I want to ask you:
I am trying to slightly modify your code to style the displayed message in Slack in a bit different way.

moay

justshipit What do you want to know? :-)

justshipit

moay I would like to have my notifications in Slack look this way (the top is current way, the bottom is the idea I have):

I have identified DiscussionWasStartedMessage.php file that is responsible for the message but there are also other files involved that makes it whole.

luceos

If i have the time I'll send in a PR that moves NotifyMe into your code, that will help support more channels than you need.

moay

luceos That's pretty easy, just needs to be integrated and some new connectors for the new services. I had plans to integrate this when beta 3 is there... :-) The JS parts should be cleaned up, I bet there are more scalable ways to build the interface... ;-)