RetentIQ Platform Documentation
Developer Guide & APIs
Last Updated: June 13, 2026 • Version 1.0.0-Beta
1. Quick Start Ingestion
To ingest customer actions and telemetry logs into RetentIQ, send a POST request containing telemetry data in JSON payload format to our events endpoint.
POST /api/events/ingest
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json
{ "events": [ { "customer_id": "customer-uuid-1234", "event_type": "feature_use", "source": "web", "occurred_at": "2026-06-14T17:10:26.389Z", "payload": { "feature": "dashboard_export" } } ] }
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json
{ "events": [ { "customer_id": "customer-uuid-1234", "event_type": "feature_use", "source": "web", "occurred_at": "2026-06-14T17:10:26.389Z", "payload": { "feature": "dashboard_export" } } ] }
2. Churn Risk Engine Calculations
RetentIQ uses a dual scoring pipeline:
- LightGBM Machine Learning Classifier: Trained on historical customer data to calculate a raw probability of churn (0.0 to 1.0).
- Rule-based weights alignment: The platform blends this probability with tenant-configured weight percentages (defined in the Score Weights setting) to compute the final 0–100 health index.
3. Inbound Webhooks Sync
Configure Segment, HubSpot, Salesforce, Stripe, and Intercom webhooks to route customer activity directly to RetentIQ. All endpoints are mapped to path format:
https://api.retentiq.com/api/integrations/<provider>/webhook