External API

The Whagons external API is the programmatic surface connected to API keys created in Settings → Integrations → API Keys.

Use it to connect a help desk, property system, sensor workflow, automation platform, reporting process, or AI agent to the same permission-aware work users see in Whagons.

What v1 supports

• Read workspaces, spots, users, task reference data, and visible tasks.
• Create, update, delete, comment on, assign, tag, approve, and acknowledge tasks.
• Authenticate with a tenant API key or a user-approved agent token.
• Apply the current permissions and visibility of the user behind the credential.

Base URL

The current production base URL is:

https://cvx-share.whagons.com/api/v1

The gateway is shared, but access is tenant-specific. Every request supplies the tenant's tenantId, and the credential must belong to that same tenant.

Integration pattern

Most integrations follow the same reliable sequence:

1. Create and securely store a dedicated API key.
2. Read workspaces and other reference data.
3. Save the Whagons IDs that map to the external system.
4. Create or operate on tasks with those IDs.
5. Handle permissions and stale reference data explicitly.
6. Rotate the key without interrupting the integration.

The API does not provide a second, broader authorization model. If the key creator cannot see or change something in Whagons, the key cannot either.

OpenAPI

The machine-readable OpenAPI 3.1 document is public:

https://docs.whagons.com/openapi/whagons-v1.json

Use it for client generation and schema inspection, but read the conceptual guides for tenant visibility, task policy, and safe credential handling.

Compatibility

The /api/ext/* paths still work. New integrations should use /api/v1/* so future breaking changes can be handled with normal API versioning.

Continue with the five-minute quickstart.