CRAIM already publishes backend API documentation through Swagger in deployed environments.
Where to start
- use the website documentation for product concepts and setup guidance
- use Swagger for endpoint-level request and response details
API areas already present in the backend
- auth and users
- companies and invitations
- leads, deals, tasks, messages
- knowledge
- channels and integrations
- marketing
- AI actions and AI workspace
- AI calls
- subscriptions
Webhook-heavy areas
- CRM integrations
- lead sources
- communication channels
- telephony providers
Documentation principle
Product docs should explain what each API area is for.
Swagger should remain the source for precise endpoint contracts.
What good API docs should include
- authentication expectations
- company scoping rules
- webhook verification notes
- idempotency guidance for inbound callbacks
- links to the relevant product workflows