Skip to content

Add API documentation for my notifications endpoint#395

Open
robzolkos wants to merge 2 commits intobasecamp:masterfrom
robzolkos:document-my-notifications-endpoint
Open

Add API documentation for my notifications endpoint#395
robzolkos wants to merge 2 commits intobasecamp:masterfrom
robzolkos:document-my-notifications-endpoint

Conversation

@robzolkos
Copy link

Summary

  • Documents the GET /my/readings.json endpoint as "My notifications" — the API behind the Hey! menu
  • Documents the PUT /my/unreads.json endpoint for marking notifications as read
  • Adds "My notifications" to the README endpoint index

Copilot AI review requested due to automatic review settings March 12, 2026 20:46
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new documentation section for the “My notifications” API (the endpoints backing Basecamp’s “Hey!” menu), and links it from the main README endpoint index.

Changes:

  • Added sections/my_notifications.md documenting GET /my/readings.json and PUT /my/unreads.json.
  • Added “My notifications” to the README endpoint index.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
sections/my_notifications.md New endpoint documentation for listing notifications and marking them read, including example payloads/cURL.
README.md Adds “My notifications” to the API endpoint index.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants