API reference paths now match the live API
What changed
The API reference now documents every endpoint at the path the API actually serves. Eight endpoints across four groups had been listed under a prefix the server does not use, and they now appear at their live paths:
- Webhook management is under
/v1/webhooks, previously documented under a separate/v1/webhook-endpointsprefix. - Registration, password reset, and email verification appear under
/v1/auth. - Sending an invoice by email and downloading an invoice PDF appear under
/v1/invoices. - The migration endpoints appear under
/v1/migration.
For example, listing your webhook endpoints:
curl https://api.speybooks.com/v1/webhooks \
-H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"endpoints": [
{
"id": 42,
"url": "https://example.com/hooks/speybooks",
"events": ["invoice.created", "invoice.paid"],
"isActive": true
}
],
"availableEvents": ["invoice.created", "invoice.paid"]
}
}
Why it matters
If you generated a client from the published reference, four of these groups pointed at paths the API never served, so those calls returned 404. The reference now matches the running API for all 209 endpoints, so what you read is what you can call.
The more durable change is underneath. The reference is now generated from the same route definitions the server registers, rather than from a second, hand-maintained list. A documented path can no longer drift from the served path, because a route is declared in exactly one place. When an endpoint is added or moved, the reference follows it.
Proof and impact
The full reference, 209 endpoints, is regenerated from the live route definitions on every release, so the documented paths and the served paths are the same set by construction.
No breaking change. No live endpoint moved; these are the paths the API already served, and only the reference corrected to match them. If you had been calling the previously documented paths for webhook management, registration, password reset, email verification, invoice email, invoice PDF, or migration, switch to the paths shown above and in the reference.
Known issues
None.