Matrix Notifications Plugin for Emby

[darkside40 107]

Matrix Notifications Plugin for Emby

Based on my Telegram Notifications Plugin i build a Plugin suitable for the Matrix Messaging Protocol. the simple advantage is that you can host your own server for it which does not rely on other people. Nope it is not in the Plugin catalog, because there are only plugins by developers which are "willing to fully support it.  That means keep it up to date with server versions as well as fix any issues and respond to user help requests." Because of the closed source code of Emby and the lack of Plugin development documentation that is something i cannot ensure.

 

What it does?

It simply forwards the Messages of the Emby Notification Framework to a Matrix Room. Not more, not less. Sorry no fancy posters etc. because the Standard Notifications of Emby dont support it.  That could be hacked into, but those things can break easily on every update.

Install

1. Install the Plugin by downloading the DLL (or build it yourself using VS2017/VS2019) and putting it into your Emby Plugin folder
2. Restart your Emby Server
3. Grab yourself the Element Messenger and curl (of something similier to talk with the API)
4. Your server needs a user account on the matrix instance to use, so register on for it
5. Start Element with your own account and create a room, deactive encryption (important), i made mine invite only.
6. Invite your Emby Server to the room
7. Head to the room settings you will find the internal Room ID, something like: !klblablabla:matrix.org an note it

Now it is time to start playing with curl to get Access Token of your Emby user and join the room Mind changing the TLD etc accoring to your needs.

8. Start with getting your Access Token curl -XPOST -d '{"type":"m.login.password", "user":"EMBYSERVERUSER", "password":"EMBYSERVERPASSWORD"}' "https://matrix.org/_matrix/client/r0/login"

9. Join the room (the ! in the room ID must be exchanged with ah %21) curl -XPOST -d '{}' "https://matrix.org/_matrix/client/r0/rooms/%21klblablabla:matrix.org/join?access_token=ACCESSTOKEN"

10. Test the connection curl -XPOST -d '{"msgtype":"m.text", "body":"hello"}' "https://matrix.org/_matrix/client/r0/rooms/%21klblablabla:matrix.org/send/m.room.message?access_token=ACCESSTOKEN"

11. Go to the Plugin settings page and fill in the Access Token, Room ID (like you copied it from Element aka with the ! at front), and the Server TLD (dont forget the / at the back)

12. Send a Test Notification

13. Activate the Matrix Notifications Plugin in the desired Server notifications

Known Issues?

It does not support E-2-EE because there is no SDK for it. Of course TLS will be used.

 

Where to get it?

You can download the Source and DLL on Github or attached to this thread.

https://github.com/bjoerns1983/Emby.Plugin.MatrixNotification/releases

Have fun with it. If you have a cool idea simply open a Github Issue.

Would be cool to have this registration process handled on the settings page, but thats beyond my Scope. PR welcome!

 

Emby.Plugin.MatrixNotification.dll

[dual-o 19]

Hello, thank you for this plugin. This would be very helpful for alle the emby/matrix guys!

Just an other idea...

It would be great to have a plugin to send the notification framework to a webhook so we can use one plugin for alle the webhook-bridges in serval messengers.

[GWTPqZp6b 50]

Thank you.

[darkside40 107]

2 hours ago, dual-o said:

Hello, thank you for this plugin. This would be very helpful for alle the emby/matrix guys!

Just an other idea...

It would be great to have a plugin to send the notification framework to a webhook so we can use one plugin for alle the webhook-bridges in serval messengers.

The idea looks quite appealing and doing that wouldnt take more than 10min based on the Matrix Plugin.

Althought there are some caveats. You know there is no Webhook standard, rfc or spec. Everybody who does Webhooks does them a bit different. Normally it is a post request with a json payload. But it already starts with the naming of the Key:Value pairs. As long as you parse it yourself eg with NodeRed that does not matter. but you simply cannot do a plugin that is compatible with every Messenger that claims to use Webhooks.

Also like i stated many time here, the Emby Notification Framework is very limited. For each scan it gives you only 10 Names or i thin 6 Names + Descriptions back. If you add 100 Movies at once you loos 90 or 94 entries. Also there are no more info, only Name (Title) and Description.

The better way would be that the Emby Dev's add a New Content Webhook, okay that would have the caveat that only paying members would have access to but the possibilities would be enormous.

If you like that idea reply to the following post to show some love to it, so it don't dissappears in the New Feature Friendzone like so many other good ideas.

Maybe we also would get an ETA for that

[dual-o 19]

Thanks for the fast and detailed answer. Hope we can get this feature in the future.

Thanks again for your work!

[GWTPqZp6b 50]

21 minutes ago, darkside40 said:

the Emby Notification Framework is very limited. For each scan it gives you only 10 Names or i thin 6 Names + Descriptions back. If you add 100 Movies at once you loos 90 or 94 entries. Also there are no more info, only Name (Title) and Description.

Thanks for sharing this, this is somewhat limiting. Are you aware of a backlog ticket that users can vote on to encourage/prioritise emby devs work to improve notifications?

EDIT: Looks like my question was answered above  Thx

Edited February 10, 2022 by GWTPqZp6b

[darkside40 107]

1 minute ago, GWTPqZp6b said:

Thanks for sharing this, this is somewhat limiting. Are you aware of a backlog ticket that users can vote on to encourage/prioritise emby devs work to improve notifications?

No i am not aware of something like this. Because of that i am pushing that thread for the new webhook so maybe someone hears it and sees that there is a demand for it. 
 

you could also try the Playback reporting plugin. It also has a new media notification which at least show you all Movies/Episode added since the last rum. 

[GWTPqZp6b 50]

@darkside40 Could you be able to update this plugin to work with the revised 4.8.0.20 notification system?

[darkside40 107]

I will have a look at the PR i got from @Luke for the Telegram Plugin an than port it when i find time for it.

 

Edited December 19, 2022 by darkside40

[darkside40 107]

Pushed a v1.1 compatible with Emby 4.8, hopefully.

Feel free to test.

[dual-o 19]

Have you also added the feature to use the new 4.8.0.20 notification system?

On 12/19/2022 at 6:49 AM, GWTPqZp6b said:

@darkside40 Could you be able to update this plugin to work with the revised 4.8.0.20 notification system?

 

[darkside40 107]

Thats what this Update is all about.

[GWTPqZp6b 50]

working fine here  thank you!

Edited January 14, 2023 by GWTPqZp6b
unable to keyboard

[GWTPqZp6b 50]

Having had a bit of time to use with this plug I've noticed I'm not getting all alerts, for example I get new media added alerts fine, but dont see alerts when media is played/updated etc. Is this likely to be related to the underlying modifications code, or the matrix plugin? Will grab some debug logs tomorrow just want to make sure I direct them appropriately. 

[darkside40 107]

Becasue this plugin only forward what it gets from the notification framework i would say its better to ask in the support thread for it.

[darkside40 107]

Dont know if anybody still uses this plugin, but i have ported some of the changes of my Telegram Plugin to it.

Version 1.2.0.0 can finally send poster into a chat. You can find the release in my Codeberg Repo: https://codeberg.org/bjoerns1983/Emby.Plugin.MatrixNotification/releases/tag/v1.2.0.0

Please dont use the DLL from the starting post, it is completely outdated, but i am not allowed to edit the post.

Messages with posters will be send in to messages, one for the posters and one for title description. The Matrix Client Server Api is a bit quirky, and i dont know if every client implements it the same way. I have only tried it with Element on Linux and ElementX on iOS. So if you encounter any issues feel free to colaborate on Codeberg by opening in issue or sending a PR.

Have fun with the Plugin.

[GWTPqZp6b 50]

Yup, Still using the previous version, thank you. 

[darkside40 107]

No Problem, if you have any experiences with other clients than Element etc. feel free to share.

[darkside40 107]

I created a small landingpage for my addons because i am not allowed to edit my startposts anymore: https://bjoerns1983.codeberg.page/

If you want to stay updated you can also use the rss feed you find on the Codeberg release page: https://codeberg.org/bjoerns1983/Emby.Plugin.MatrixNotification/releases

[GWTPqZp6b 50]

Will do, thanks @darkside40Verified 1.2.0.0 working fine here.
Small request, it would be useful to be able to disable posters/descriptions per event type. 
For example, I would like to display artwork when a user starts playing a movie, but not when they stop playing it. 

[darkside40 107]

Simply use multiple instances of the Notifications Plugin:

The upper one is configure to send posters when new content is added, the lower one sends player events with posters disabled.

[GWTPqZp6b 50]

Aha! thanks. 

[darkside40 107]

No problem, had to check it by myself first to see if it is working.

Do you use Emby 4.8 or 4.9?

[GWTPqZp6b 50]

4.9 latest beta.