Idea: Home Assistant Integration for paperless

[morremeyer]

This is not an issue per se, it’s more of a „would you also be interested in this?“ question/request for feedback.

I started using paperless-ng not long ago and thought about adding even more automation to it - such as Home Assistant notifying me about new documents, finished document processing, whatever nice things we can do with it.

So I thought about writing an integration for paperless-ng that uses paperless-ng's REST API to produce some useful sensors.

@TheBestMoshe Is this something that you would like to have/would use?

[TheBestMoshe]

This sounds like a great idea. I would definitely add it to my HA instance.

[tobi-bo]

Found this while searching for an integration for paperless-ng. I would really like to have this. 👍

[morremeyer]

It’s on my to-do list, so I’ll definitely get to it at some point in time and get back here. My tracking issue is https://gitlab.com/morremeyer/tech-and-learning/-/issues/7.

@TheBestMoshe Should we close this one? Could make sense because it doesn’t really have to do with the project.

[bendavis]

I've been actively working on this for about a week - right now I'm only reading recent documents by API and rendering using the upcoming media card - https://github.com/custom-cards/upcoming-media-card .

[ridizy]

I just started using paperless-ngx and would love to see this integration as well. Thanks for considering building something

[financelurker]

I would also love an integration for paperless in home assistant!

This https://github.com/ItsEcholot/ha-paperless-ng-sensor could be a starting point, since it already provides simple sensors for document counts.

[blackgold9]

Did anone ever get this going? I'm poking at ItsEcholot's sensor trying to get it going, but would love to know if anyone has already solved this.

[morremeyer]

I never started work on it, priorities shifted.

[blackgold9]

Ahh, I found a simple thing for my needs. I configured a REST sensor using a long lived token for auth and this lets me get my count of inbox and todo documents, which is all i wanted.

[Rudertier]

@blackgold9 Do you mind posting your Sensor-config here? I was looking at the docs just yesterday and figured it would be a nice evening project. But if you have alreade figured it out... 😊

[blackgold9]

sensor:
  - platform: rest
    resource: https://paperless.server.com/api/documents/
    headers:
      Authorization: !secret paperless_auth_header
    params:
      query: "tag:inbox"
    value_template: "{{ value_json.count }}"
    name: "Paperless Inbox"

Then in my secrets file:

paperless_auth_header: Token <token>

The token is generated by paperless if you go to settings->Django Admin->Tokens