Glossary¶
This document defines key terms and concepts used throughout the WhiteLabelCRO integration documentation.
Terms¶
Action¶
A write operation that creates or updates data in WhiteLabelCRO via the Integration API (e.g., Create Lead, Update Client, Add Client Note).
Affiliate¶
A referral partner entity in WhiteLabelCRO that generates leads or clients.
API key¶
A long-lived authentication credential used to access the Integration API. Each key has specific scopes that control permitted operations.
Canonical Event¶
An immutable record of a business event that occurred in WhiteLabelCRO. Each event has a unique ID, timestamp, type, and payload.
Client¶
A customer entity in WhiteLabelCRO that moves through various lifecycle stages (Lead, Active Client, etc.).
Cursor¶
A pagination token used to retrieve the next batch of results when polling events via the Integration API.
Deduplication¶
The practice of using event IDs or external IDs to prevent duplicate processing of events or creation of duplicate records.
Delivery Log¶
A record of each webhook delivery attempt, including HTTP status code, response body, and elapsed time.
Event Envelope¶
The standard wrapper structure for all events, containing id, type, createdUtc, companyId, payload, and metadata fields.
Event Type¶
A string identifier for a specific kind of business event, following the pattern {domain}.{action} (e.g., client.created, payment.succeeded).
External ID¶
A field used to link WhiteLabelCRO records to records in external systems, enabling cross-system integration and deduplication.
Idempotency¶
The property that allows an operation to be safely repeated without causing duplicate side effects. Use event IDs or request IDs to achieve idempotency.
Integration API¶
The REST API that provides access to WhiteLabelCRO events, actions, and searches. Used by Zapier, n8n, Make, and custom integrations.
Payload¶
The JSON object within an event envelope containing event-specific data fields.
Rate Limit¶
A restriction on the number of API requests allowed within a time window. Enforced per API key across different operation buckets (read, write, admin).
REST Hooks¶
A pattern where the consuming platform (e.g., Zapier) automatically manages webhook subscriptions via API calls when users enable or disable integrations.
Scope¶
A permission granted to an API key that controls which operations it can perform (e.g., events:read, integrations:write).
Search¶
A read operation that finds existing records in WhiteLabelCRO based on search criteria (e.g., Find Client by email).
Signing Secret¶
A secret key used to generate HMAC-SHA256 signatures for webhook deliveries, enabling recipients to verify authenticity.
Subscription¶
A webhook subscription configuration that specifies a target URL and which event types to deliver to that endpoint.
Trigger¶
An operation in automation platforms (Zapier, n8n, Make) that starts a workflow when a specific event occurs in WhiteLabelCRO.
Webhook¶
A push-based delivery mechanism where WhiteLabelCRO sends HTTP POST requests to external endpoints when events occur.