Zapier Triggers¶

This document describes the triggers available in the WhiteLabelCRO Zapier integration.

How Triggers Work¶

Zapier triggers use the REST Hooks pattern for real-time event delivery:

When you enable a Zap, Zapier automatically subscribes to the selected event type
When matching events occur in WhiteLabelCRO, they are pushed to Zapier immediately
When you disable a Zap, Zapier automatically unsubscribes

This provides near real-time delivery without polling delays.

Available Triggers (10)¶

Client Triggers¶

New Client Created (client.created) - Fires when a new client is enrolled in the system - Key fields: client_id, first_name, last_name, email, phone, status, created_date

Client Status Changed (client.status_changed) - Fires when a client moves to a different lifecycle stage - Key fields: client_id, previous_status, new_status, changed_date

New Lead Created (lead.created) - Fires when a new lead is captured - Key fields: client_id, first_name, last_name, email, phone, status, created_date

Billing Triggers¶

New Invoice Created (invoice.created) - Fires when a new invoice is generated - Key fields: invoice_id, client_id, amount, due_date, description, invoice_status

Invoice Status Changed (invoice.status_changed) - Fires when invoice payment status changes (Unpaid to Paid, etc.) - Key fields: invoice_id, previous_status, new_status, total_paid, balance

Payment Succeeded (payment.succeeded) - Fires when a payment processes successfully - Key fields: payment_id, invoice_id, client_id, payment_amount, payment_method, date_paid

Payment Failed (payment.failed) - Fires when a payment attempt is declined - Key fields: payment_id, invoice_id, client_id, amount_attempted, failure_reason

Partner Triggers¶

New Affiliate Created (affiliate.created) - Fires when a new referral partner is added - Key fields: employee_id, full_name, email, phone, is_approved_affiliate, created_date

Document Triggers¶

Document Uploaded (document.uploaded) - Fires when a file is added to a client record - Key fields: client_doc_id, client_id, doc_name, doc_type_name, created_date

Compliance Triggers¶

Agreement Signed (agreement.signed) - Fires when a client electronically signs a document - Key fields: agreement_signed_id, client_id, signed_date, name_signed, agreement_name

Trigger Configuration¶

Selecting Event Types¶

When configuring a trigger in Zapier: 1. Choose the trigger type (e.g., "New Client Created") 2. Connect your WhiteLabelCRO account if not already connected 3. Zapier will load sample data for field mapping 4. Map fields to subsequent Zap steps

Sample Data¶

During Zap setup, Zapier requests sample data from WhiteLabelCRO to populate the field picker. This allows you to map event fields to subsequent actions without waiting for a real event.

Output Fields¶

Each trigger returns an event envelope containing: - id - Unique event identifier (use for deduplication) - type - Event type name - createdUtc - Event timestamp - payload - Event-specific data (flattened for Zapier)

Nested payload fields are flattened using double underscore notation (e.g., payload__client_id).

Deduplication¶

Zapier handles deduplication automatically using the event id field. If the same event is delivered multiple times, Zapier will only trigger your Zap once.

Troubleshooting¶

Triggers Not Firing¶

Verify the Zap is turned ON
Check that the event type matches what you're expecting
Verify your API key is valid
Generate a new key from Settings > Setup > Third Party Settings if needed

Missing Fields¶

Some optional fields may be null depending on the data in WhiteLabelCRO. Use Zapier's "Formatter" step to handle missing values.

Delayed Triggers¶

REST Hooks provide near real-time delivery. If you experience delays: 1. Check Zapier's task history for queued tasks 2. Verify WhiteLabelCRO webhook delivery logs show successful delivery 3. Contact support with the X-Request-ID from delivery logs