Skip to content

n8n Overview

This document provides an overview of using the WhiteLabelCRO Integration API with n8n.

What is the n8n Integration

n8n is an open-source workflow automation platform. You can use n8n to connect your WhiteLabelCRO CRM to hundreds of apps and services. n8n is a consumer of the Integration API, using the same endpoints, authentication, and data formats as Zapier, Make, and custom integrations.

Available Operations

Triggers (10)

Event-driven workflows via webhook or polling: - client.created - New client enrolled - client.status_changed - Client stage transition - lead.created - New lead captured - invoice.created - New invoice generated - invoice.status_changed - Invoice payment status updated - payment.succeeded - Successful payment processed - payment.failed - Payment declined - affiliate.created - New referral partner added - document.uploaded - File attached to record - agreement.signed - E-signature completed

Actions (9)

Create and update operations: - Create Lead - Add new lead - Create Client - Enroll new client - Update Client - Modify client details - Update Client Status - Change client stage - Add Client Note - Attach note to client record - Update Lead - Modify lead details - Update Lead Status - Change lead stage - Create Affiliate - Add referral partner - Update Affiliate - Modify affiliate details

Searches (2)

Find-or-Create pattern support: - Find Client - Search by email, phone, client ID, or external ID - Find Lead - Search by email, phone, client ID, or external ID

Implementation Approaches

For real-time event processing: 1. Create a webhook subscription via POST /api/v1/webhooks/subscriptions 2. Use n8n's Webhook node to receive events 3. WhiteLabelCRO pushes events to your n8n webhook URL in real-time 4. Delete subscription when workflow is no longer needed

Polling

For periodic event retrieval: 1. Use n8n's HTTP Request node with GET /api/v1/events 2. Set up a Schedule trigger node (e.g., every 5 minutes) 3. Process new events using cursor-based pagination

See /04-api-reference/events-api.md for polling implementation details.

Authentication

  • API Key via X-Api-Key header
  • Configure credentials in n8n's credential management
  • Keys managed in WhiteLabelCRO Admin Portal

Getting Started

  1. Obtain API key from WhiteLabelCRO Admin Portal (Settings > Integrations > API Keys)
  2. In n8n, create a new workflow
  3. Add HTTP Request node (for actions/searches) or Webhook node (for triggers)
  4. Configure credential with your API key
  5. Set request headers: X-Api-Key: your_key_here
  6. Configure endpoint URL and parameters

Platform Compatibility

The same Integration API works with: - Zapier - No-code automation platform - Make (Integromat) - Visual automation platform - Custom applications - Any HTTP client

All platforms use the same endpoints, authentication, and data formats.

Limitations

  • Rate limits apply (60 reads/min, 100 writes/min per API key)
  • Manual webhook subscription management (unless using REST Hooks pattern)
  • API responses require parsing/mapping in workflow nodes