What is the Integration Platform¶

The WhiteLabelCRO Integration Platform enables your credit repair business to connect with external systems through a unified event-driven architecture. It provides both outbound notifications (events from WhiteLabelCRO to your systems) and inbound operations (actions from your systems into WhiteLabelCRO).

Core Concepts¶

Canonical Events¶

The platform produces a single stream of canonical business events. A canonical event is a durable record that captures when something meaningful happens in the system:

Event ID: Unique identifier for deduplication
Timestamp: When the event occurred (UTC)
Event Type: What happened (e.g., client.created, payment.succeeded)
Subject: The primary entity involved (client ID, invoice ID, etc.)
Payload: JSON snapshot of relevant data at the time of the event

Canonical events are append-only. Once created, they are never modified.

Delivery Methods¶

Events can be consumed through two delivery methods:

Webhooks (Push Model) - WhiteLabelCRO sends HTTP POST requests to your registered endpoint - Near real-time delivery - Requests are signed with HMAC-SHA256 for verification - Automatic retry with exponential backoff on failure

Integration API (Polling/REST Hooks) - Poll events via GET /api/v1/events - REST Hooks for Zapier, n8n, Make (automatic subscription management) - Actions and searches for bidirectional sync

Both methods use the same event types, payloads, and infrastructure. Choosing between them depends on your technical capabilities and use case requirements.

What You Can Automate¶

Outbound Capabilities (Events)¶

The platform emits 10 canonical event types in v1:

Billing Events (4) - invoice.created - New invoice generated - invoice.status_changed - Invoice payment status changed - payment.succeeded - Payment processed successfully - payment.failed - Payment attempt declined

Client Events (3) - client.created - New client enrolled - client.status_changed - Client lifecycle stage changed - lead.created - New lead captured

Partner Events (1) - affiliate.created - New referral partner added

Document Events (1) - document.uploaded - File added to client record

Compliance Events (1) - agreement.signed - Client signed a document

Inbound Capabilities (Actions)¶

Actions allow external systems to create or modify records: - Create Lead, Create Client - Update Client, Update Client Status - Add Client Note - Update Lead, Update Lead Status - Create Affiliate, Update Affiliate

Searches allow lookups before taking action: - Find Client (by email, phone, or external ID) - Find Lead (by email, phone, or external ID)

Platform Benefits¶

Single Source of Truth¶

All integrations consume the same canonical event stream. Whether you use webhooks, Zapier, n8n, Make, or custom code, you receive identical data.

Diagram¶

flowchart LR
    WLCRO[WhiteLabelCRO CRM]
    Events[Canonical Event Stream]

    WLCRO -->|Emits Events| Events

    Events -->|Push| Webhooks[Custom Webhooks]
    Events -->|REST Hooks/Polling| Zapier[Zapier]
    Events -->|Webhooks/Polling| n8n[n8n]
    Events -->|Webhooks/Polling| Make[Make]
    Events -->|Webhooks/Polling| Custom[Custom Integrations]

    Zapier -->|Actions/Searches| WLCRO
    n8n -->|Actions/Searches| WLCRO
    Make -->|Actions/Searches| WLCRO
    Custom -->|Actions/Searches| WLCRO

    style WLCRO fill:#e1f5ff
    style Events fill:#fff4e6

Extensible Architecture¶

The event-driven design allows adding new consumers without reworking the event model.

Security by Design¶

API key authentication with scoped permissions
HMAC-SHA256 webhook signatures
HTTPS required for all production endpoints
Sensitive data (SSN, bank accounts, full card numbers) never exposed

Compatibility¶

The Integration API works with: - Zapier - No-code automation platform - n8n - Open-source workflow automation - Make (Integromat) - Visual automation platform - Custom applications - Any HTTP client can consume the API