Downline Events

Receive webhook events when downline agencies take key actions in White Swan.

Subscribe to this webhook to receive real-time notifications when activity occurs on downline agencies linked to your account.

---

Sample Payload

{
  "event_name": "Onboarding Completed",
  "event_date": "2024-03-15T14:30:00Z",
  "linked_company": {
    "company_id": "1776772304993x692932671527100400",
    "company_name": "Acme Insurance Group",
    "company_address": "123 Main St, Austin, TX 78701, USA",
    "company_legal_name": "Acme Insurance Group LLC",
    "company_subscription": "Digital Agent",
    "company_allowed_policy_types": [
      "Term Life",
      "Whole Life",
      "Indexed Universal Life"
    ],
    "company_allowed_carriers": [
      "John Hancock",
      "Nationwide"
    ],
    "company_upline": "Premier Brokerage Network",
    "linked_case_ids": [
      "1776772304993x111111111111111111",
      "1776772304993x222222222222222222"
    ],
    "linked_user_emails": [
      "[e-mail]",
      "[e-mail]"
    ],
    "linked_payments": [
      "1776772304993x333333333333333333",
      "1776772304993x444444444444444444"
    ],
    "has_completed_onboarding": true,
    "linked_terms": [
      {
        "acceptance_id": "1776772304993x555555555555555555",
        "accepted": true,
        "accepted_date": "2024-03-15T14:28:00Z",
        "consent_text_shown": "I agree to the White Swan Partner Agreement",
        "consenting_user_email": "[e-mail]",
        "accepted_contract": "https://app.whiteswan.io/contracts/partner-agreement-v2.pdf",
        "contract_type": "Partner Agreement",
        "acceptance_url": "https://app.whiteswan.io/onboard/terms"
      },
      {
        "acceptance_id": "1776772304993x666666666666666666",
        "accepted": true,
        "accepted_date": "2024-03-15T14:29:10Z",
        "consent_text_shown": "I agree to receive electronic communications",
        "consenting_user_email": "[e-mail]",
        "accepted_contract": "https://app.whiteswan.io/contracts/electronic-consent.pdf",
        "contract_type": "Electronic Consent",
        "acceptance_url": "https://app.whiteswan.io/onboard/terms"
      }
    ]
  }
}

Data Returned by this Event:

Field Label	Field Key	Field Type	Example Value	Description
Event Name	event_name	Multiple-choice	Account Created	See options below.
Event Date	event_date	Date/Time in ISO 8601	2024-03-15T14:30:00Z	The time the event happened.
Company Object	linked_company	Object	See Downline object	A Downline object - see full Downlines documentation for shape reference.

Types of Events:

Event	Description
Account Created	A downline agency account has been created
Plan Selected	A downline agency has selected a White Swan plan
New Terms Accepted	A downline agency has accepted new terms
Onboarding Completed	A downline agency has completed the onboarding flow
New Case	A new case has been created under a downline agency
New User	A new user has been added to a downline agency