Payout Events

Receive webhook events when inbound or outbound payouts are recorded in White Swan.

This event happens when a new payout event is recorded under your White Swan account. The event can be either Inbound Payout or Outbound Payout.

Payout events are not available for Innovator Plan accounts.

---

Sample Payload

{
  "event_name": "Inbound Payout",
  "event_date": "2026-04-20T14:32:00Z",
  "linked_payout": {
    "payout_id": "ws_payout_001234",
    "payout_external_id": "ext_987654321",
    "direction": "Inbound Money",
    "source_system": "BackNine",
    "amount": 1250.75,
    "payment_date": "2026-04-19T10:15:00Z",
    "payment_method": "ACH",
    "status": "Completed",
    "status_note": "Funds settled successfully",
    "recipient": {
      "type": "Agent",
      "id": "agent_56789",
      "name": "John Doe",
      "email": "[e-mail]",
      "phone": "[phone]",
      "address": {
        "street_address": "123 Main St",
        "city": "Austin",
        "state": "TX",
        "zip": "78701",
        "country": "US",
        "address_type": "Business"
      }
    },
    "payor": {
      "id": "carrier_abc123",
      "name": "Acme Life Insurance Co.",
      "email": "[e-mail]",
      "phone": "[phone]",
      "address": {
        "street_address": "456 Market St",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94105",
        "country": "US",
        "address_type": "Headquarters"
      }
    },
    "linked_commission_line_item_ids": [
      "comm_001",
      "comm_002"
    ],
    "linked_case_ids": [
      "case_78910",
      "case_78911"
    ]
  }
}

Data Returned by this Event:

Field Label	Field Key	Field Type	Example Value	Description
Event Name	event_name	Multiple-choice	Inbound Payout, Outbound Payout	Whether the payout is received or recorded as paid out to a downline inside the White Swan commissions dashboard.
Event Date	event_date	Date/Time in ISO 8601	2025-03-21T00:00:00.000Z	The date of the payout event.
Payout Event Object	linked_payout	Object	See Payouts object	A Payouts object - see full Payouts documentation for shape reference.