> For the complete documentation index, see [llms.txt](https://docs.whiteswan.io/partner-knowledge-base/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.whiteswan.io/partner-knowledge-base/api-documentation/webhooks/payout-events.md).

# Payout Events

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.

{% hint style="info" %}
Payout events are not available for [Innovator Plan](/partner-knowledge-base/platform-overview/plans-to-access-platform/innovator-plan.md) accounts.
{% endhint %}

***

<details>

<summary>Sample Payload</summary>

```json
{
  "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": "john.doe@example.com",
      "phone": "+1-555-123-4567",
      "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": "payments@acmelife.com",
      "phone": "+1-800-555-7890",
      "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"
    ]
  }
}
```

</details>

**Data Returned by this Event:**

<table data-full-width="true"><thead><tr><th>Field Label</th><th>Field Key</th><th>Field Type</th><th>Example Value</th><th>Description</th></tr></thead><tbody><tr><td>Event Name</td><td>event_name</td><td>Multiple-choice</td><td>Inbound Payout, Outbound Payout</td><td>Whether the payout is received or recorded as paid out to a downline inside the White Swan commissions dashboard.</td></tr><tr><td>Event Date</td><td>event_date</td><td>Date/Time in ISO 8601</td><td><p></p><pre class="language-json"><code class="lang-json"><strong>2025-03-21T00:00:00.000Z
</strong></code></pre></td><td>The date of the payout event.</td></tr><tr><td>Payout Event Object</td><td>linked_payout</td><td>Object</td><td>See <a href="/pages/Nw1AkIoI8ZyJ6EY2JfYr">Payouts</a> object</td><td>A Payouts object - see <a href="/pages/Nw1AkIoI8ZyJ6EY2JfYr">full Payouts documentation</a> for shape reference.</td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.whiteswan.io/partner-knowledge-base/api-documentation/webhooks/payout-events.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.