Fetch the current list of persistent notifications via API

Development
1

Hi, I’m looking for a way to programmatically get somehow a list of notifications, as shown in the UI. The use case is to have an audible alarm that won’t shut up until they get silenced, to make sure they’re taken care of.
Using the phone is a lost cause, it’s spammed by too many notifications.

I’ve found this documentation so the API looks very limited at the moment. Is there another way to access that information?

Thanks

2

You would need to use a websocket connection and the HA websocket api. You can then either get the current list on request or subscribe to new notifications. There is a websocket client library for python (assume your external program is python) with examples how to use and documentation on the websocket api here.

The apis for persistent notifications can be seen from line 201 in the platform code.

https://github.com/home-assistant/core/blob/554ab94782d2b814074f18dcf80179eed5cee61d/homeassistant/components/persistent_notification/init.py#L201

1 Like
3

Perfect timing!
Just yesterday i played with this after this post.
As always, copy/paste, trial and error scripting! :grinning:

# https://websockets.readthedocs.io/en/stable/howto/quickstart.html

import asyncio
import websockets
import json

ws_url = "ws://localhost:8123/api/websocket"
token = "abcdefg"

async def count_pn():
    async with websockets.connect(ws_url) as websocket:

        greeting = await websocket.recv()
        # print(f"<<< {greeting}")

        data = {
        "type": "auth",
        "access_token": token 
        }
        await websocket.send(json.dumps(data))

        greeting = await websocket.recv()
        # print(f"<<< {greeting}")

        data = {
        "id": 34,
        "type": "persistent_notification/get"
        }
        await websocket.send(json.dumps(data))

        response = await websocket.recv()
        pnjson = json.loads(response)

        # Print the count of notifications
        print(len(pnjson['result']))

        # Print the notifications array
        # print(pnjson['result'])

if __name__ == "__main__":
    asyncio.run(count_pn())

You can use this for a command_line sensor.

command_line:
  - sensor:
      name: pn_count
      command: python scripts/api_ws_pn_count.py
4

This is ok if you are only running once and then closing the websocket connection but i would recommend that you keep the connection open and call get on a periodic loop basis. In which case, you need to increment the id number in your request each time and not fix it otherwise it will error.

5

Thanks for your comment.
The sensor works for me as the script is called by the sensors update intervall, or a persistent_notification trigger.
I think the connection is closed when the script ends?