Skip to main content

Integration Guides

Step-by-step guides for implementing referral partner workflows.

Client Onboarding​

Client Onboarding​

Create and link clients to your platform. Covers POST /clients, response handling (201/202/409), onboarding URLs, and linking approval flows.

Reset Test Clients​

Delete test clients to re-run the onboarding flow. Test environment only.

Webhooks​

Webhooks​

Event schemas and payload documentation for client onboarding, linking, and case events.

Webhook Setup​

Create webhook subscriptions and manage secrets.

Webhook Best Practices​

Production patterns for timeout handling, retry behavior, idempotency, and event routing.

Trigger Test Webhooks​

Fire test events on-demand to verify your webhook handler. Test environment only.

Webhook Security​

HMAC-SHA256 signature verification with code examples.

Revenue Tracking​

Revenue Tracking​

Build revenue dashboards and sync referral fees to accounting systems. Covers the Reporting API, 4-stage revenue pipeline, exchange rate handling, and reconciliation patterns.

Case Management​

After onboarding clients, use the Customer API to manage cases. These guides apply to both direct clients and referral partners: