mirror of
https://github.com/BookStackApp/BookStack.git
synced 2026-02-07 19:06:05 +03:00
Comment API Endpoints #3761
Closed
opened 2026-02-05 07:21:47 +03:00 by OVERLORD
·
11 comments
No Branch/Tag Specified
development
l10n_development
further_theme_development
release
llm_only
vectors
v25-11
docker_env
drawio_rendering
user_permissions
ldap_host_failover
svg_image
prosemirror
captcha_example
fix/video-export
v25.12.3
v25.12.2
v25.12.1
v25.12
v25.11.6
v25.11.5
v25.11.4
v24.11.4
v25.11.3
v25.11.2
v25.11.1
v25.11
v25.07.3
v25.07.2
v25.07.1
v25.07
v25.05.2
v25.05.1
v25.05
v25.02.5
v25.02.4
v25.02.3
v25.02.2
v25.02.1
v25.02
v24.12.1
v24.12
v24.10.3
v24.10.2
v24.10.1
v24.10
v24.05.4
v24.05.3
v24.05.2
v24.05.1
v24.05
v24.02.3
v24.02.2
v24.02.1
v24.02
v23.12.3
v23.12.2
v23.12.1
v23.12
v23.10.4
v23.10.3
v23.10.2
v23.10.1
v23.10
v23.08.3
v23.08.2
v23.08.1
v23.08
v23.06.2
v23.06.1
v23.06
v23.05.2
v23.05.1
v23.05
v23.02.3
v23.02.2
v23.02.1
v23.02
v23.01.1
v23.01
v22.11.1
v22.11
v22.10.2
v22.10.1
v22.10
v22.09.1
v22.09
v22.07.3
v22.07.2
v22.07.1
v22.07
v22.06.2
v22.06.1
v22.06
v22.04.2
v22.04.1
v22.04
v22.03.1
v22.03
v22.02.3
v22.02.2
v22.02.1
v22.02
v21.12.5
v21.12.4
v21.12.3
v21.12.2
v21.12.1
v21.12
v21.11.3
v21.11.2
v21.11.1
v21.11
v21.10.3
v21.10.2
v21.10.1
v21.10
v21.08.6
v21.08.5
v21.08.4
v21.08.3
v21.08.2
v21.08.1
v21.08
v21.05.4
v21.05.3
v21.05.2
v21.05.1
v21.05
v21.04.6
v21.04.5
v21.04.4
v21.04.3
v21.04.2
v21.04.1
v21.04
v0.31.8
v0.31.7
v0.31.6
v0.31.5
v0.31.4
v0.31.3
v0.31.2
v0.31.1
v0.31.0
v0.30.7
v0.30.6
v0.30.5
v0.30.4
v0.30.3
v0.30.2
v0.30.1
v0.30.0
v0.29.3
v0.29.2
v0.29.1
v0.29.0
v0.28.3
v0.28.2
v0.28.1
v0.28.0
v0.27.5
v0.27.4
v0.27.3
v0.27.2
v0.27.1
v0.27
v0.26.4
v0.26.3
v0.26.2
v0.26.1
v0.26.0
v0.25.5
v0.25.4
v0.25.3
v0.25.2
v0.25.1
v0.25.0
v0.24.3
v0.24.2
v0.24.1
v0.24.0
v0.23.2
v0.23.1
v0.23.0
v0.22.0
v0.21.0
v0.20.3
v0.20.2
v0.20.1
v0.20.0
v0.19.0
v0.18.5
v0.18.4
v0.18.3
v0.18.2
v0.18.1
v0.18.0
v0.17.4
v0.17.3
v0.17.2
v0.17.1
v0.17.0
v0.16.3
v0.16.2
v0.16.1
v0.16.0
v0.15.3
v0.15.2
v0.15.1
v0.15.0
v0.14.3
v0.14.2
v0.14.1
v0.14.0
v0.13.1
v0.13.0
v0.12.2
v0.12.1
v0.12.0
v0.11.2
v0.11.1
v0.11.0
v0.10.0
v0.9.3
v0.9.2
v0.9.1
v0.9.0
v0.8.2
v0.8.1
v0.8.0
v0.7.6
v0.7.5
v0.7.4
v0.7.3
0.7.2
v.0.7.1
v0.7.0
v0.6.3
v0.6.2
v0.6.1
v0.6.0
v0.5.0
Labels
Clear labels
🎨 Design
📖 Docs Update
🐛 Bug
🐛 Bug
:cat2:🐈 Possible duplicate
💿 Database
☕ Open to discussion
💻 Front-End
🐕 Support
🚪 Authentication
🌍 Translations
🔌 API Task
🏭 Back-End
⛲ Upstream
🔨 Feature Request
🛠️ Enhancement
🛠️ Enhancement
🛠️ Enhancement
❤️ Happy feedback
🔒 Security
🔍 Pending Validation
💆 UX
📝 WYSIWYG Editor
🌔 Out of scope
🔩 API Request
:octocat: Admin/Meta
🖌️ View Customization
❓ Question
🚀 Priority
🛡️ Blocked
🚚 Export System
♿ A11y
🔧 Maintenance
> Markdown Editor
pull-request
Mirrored from GitHub Pull Request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: starred/BookStack#3761
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @carlossierra311 on GitHub (Apr 24, 2023).
Describe the feature you'd like
I @ssddanbrown. I am working on generating notifications when a new comment is made on a page. I am trying to achieve this using your webhooks implementation and the pages API, through an Azure Function App. But in doing so, I found there's no way to get information on page comments, including users that previously commented on the page, or users that have favorited the page, which I would like to include as recipients of the notification.
I'd like to have access to the following information as part of the data sent by the "commented_on" webhook and/or the page API:
In case anyone else coming here is interested, here is my code so far (which is working, but will send notifications only to the person which last updated the page that was commented on):
Details
Describe the benefits this would bring to existing BookStack users
It will allow BookStack to have a full comment notification system that allows for proper and timely interaction around a page's content and comments. Otherwise, comments will go unnoticed most of the time, lowering the value and usability of that feature.
Can the goal of this request already be achieved via other means?
Not that I'm aware of.
Have you searched for an existing open/closed issue?
How long have you been using BookStack?
6 months to 1 year
Additional context
No response
@ssddanbrown commented on GitHub (Apr 24, 2023):
Thanks for the request @carlossierra311.
Happy to expand the API out to comments.
Though, I have been thinking about spending time reviewing comments and notifications (in-platform) in a soon release cycle, so would really prefer to wait until after then before adding them to the API, just in case there are more significant changes to be made. Multiple months away from that right now though.
If you're very eager for something now, it should be possible to hack in some endpoints specific for your use-case via the logical theme system if desired. Just shout if you want an example.
@carlossierra311 commented on GitHub (Apr 25, 2023):
Thant you @ssddanbrown. Yes, I would appreciate the example, to see if I am able to get this working as desired.
@ssddanbrown commented on GitHub (Apr 25, 2023):
@carlossierra311 Here's a very simple logical theme system functions.php which adds a
/api/commentsendpoint:Details
It'll act the same as other listing endpoints, so has the same filtering and params available. Should allow you to fetch multiple, or a single comment via filters.
Notes:
@carlossierra311 commented on GitHub (Apr 27, 2023):
Thank you @ssddanbrown. One question though: is it possible to get the commenter's email?
@ssddanbrown commented on GitHub (Apr 28, 2023):
@carlossierra311 I've updated my previous code above so that it shows the
created_byuser details, but this does not include email, that's a little bit more involved (since we specifically hide it). You can either perform another fetch to theusersapi endpoint for those details.Alternatively, if you want the email as part of the original comment list (Not something we'd do officially), then you can instead use this code:
Code
@carlossierra311 commented on GitHub (May 3, 2023):
Thank you @ssddanbrown. The 'created_by' detail worked as expected. I agree with you that exposing the commenters' emails in that way is not a good idea, so I just used the api.
Here is the code for an Azure Function that can handle the webhook request and produce notifications for the last page updater and for everyone that has made comments on the page. This is good enough for my use case, but I guess it could be modified to notify more specific users only:
Details
@ssddanbrown commented on GitHub (May 3, 2023):
Thanks for sharing that @carlossierra311 for others to use.
I'm going to re-open this, as I'd still like to add a proper in-built comments API eventually, and this thread will be good for others to find. You should be able to unsubscribe from the thread if you don't want to get updates/notifications on this.
@carlossierra311 commented on GitHub (Sep 4, 2023):
Hi @ssddanbrown. I hope I'm finding you well today.
I'm trying to update to v23.08.2, and I am getting this error code, which I think is related to the code suggested for the comments end point:
I changed line 4 of the code to be as follows, and it seems to do the trick:
use BookStack\Http\ApiController;Can you please advise on how to proceed? I don't want to break something unintentionally. Thanks
@ssddanbrown commented on GitHub (Sep 4, 2023):
@carlossierra311 Yeah, I moved a lot round in v23.06. I've updated the example you linked to with updated references. This kind of breakage may occur using the logical theme system, although not too often.
@carlossierra311 commented on GitHub (Sep 4, 2023):
Thank you @ssddanbrown.
@ssddanbrown commented on GitHub (Oct 24, 2025):
Comment API endpoints have now been added via #5850, so I'll therefore close this off.
They will be part of the next feature release.
Thanks again @carlossierra311 for the original request.