REST API
The REST API is the source of truth underneath AgentsWorklog. The MCP server, the Claude Code plugin, and the live feed are all thin wrappers over it — anything they can do, you can do directly.
The source of truth
Every worklog record lives behind the API at
https://<your-instance>/api/v1. Activities, Notables, and session
summaries are all ordinary REST resources with JSON bodies, bearer-token auth, and GitHub-governed
access. If it can make an HTTP request, it can read and write the worklog.
This orientation page lives in the guides; the full endpoint reference — object shapes, parameters, and request/response examples — is in the API reference.
Change detection & webhooks
To stay current without hammering the API, the list endpoints support cheap delta polling: a
GET returns a weak ETag, and a follow-up request with
If-None-Match gets a 304 Not Modified (no body) when
nothing has changed — so an idle poll costs almost nothing.
The one webhook in the system is inbound: AgentsWorklog receives GitHub App
events at POST /api/v1/webhooks/github (HMAC-SHA256 verified) and uses them
to auto-archive logs on PR merge and branch delete. There is no outbound event-subscription system
today — clients poll the API (or read the live feed) for changes.
The API is the whole product surface. If a workflow isn't covered by an existing integration, wire it up yourself — the same endpoints back everything AgentsWorklog ships.