Agiled Docs

Use this page to record notable public API changes as the surface grows.

Current Notes

Public API routes are mounted under /public/v1.
API keys are managed from Settings > API.
Generated OpenAPI reference pages are available from the docs app.
Webhook subscriptions and delivery history are managed from Settings > API and public webhook endpoints.

How To Use This Changelog

Review this page before updating an integration. It should help developers spot new resources, new filters, response shape changes, webhook changes, and behavior that may affect existing sync jobs.

For exact endpoint parameters and schemas, use the generated OpenAPI reference. This page is a human-readable companion, not a replacement for the generated reference.

What to Record Here

New resources.
New filters, includes, or sort fields.
New webhook events.
Breaking changes or deprecations.
Authentication, rate-limit, or idempotency behavior changes.

Change Categories

Added: new endpoint, field, include, filter, sort, webhook event, or helper guide.
Changed: behavior changed without removing the old endpoint, such as a default sort, validation rule, or response field.
Deprecated: a field or behavior still works but should be replaced.
Removed: a breaking removal from the public API surface.
Fixed: bug fixes that may explain a difference in integration behavior.

Integration Review Checklist

When a change affects your integration:

Compare the generated OpenAPI schema against your request and response parser.
Test with a read-only request first.
Test one write request in a controlled workspace.
Review webhook delivery logs if events changed.
Update retry, idempotency, and error handling before broad rollout.

When documenting an API change, include the affected endpoint, event, field, or filter, the date it changed, whether action is required, and a short migration note. Integrators should be able to tell whether they need to update code, rerun a sync, rotate a secret, or only be aware of the change.

For breaking changes, add the replacement path and enough lead time for external systems to test against the new behavior.

Review Before Deploying

Before deploying an integration change, check this changelog and the generated OpenAPI reference together. The changelog explains intent and migration notes; the generated reference confirms current request and response shapes.

If a change affects webhooks, also review recent delivery history after release to confirm receivers still process the expected events.

Public API Changelog