# New Earnings Event

This trigger runs when a new earnings event occurs in your White Swan account. The events can either be for payments made to you or amounts credited to your account.

{% hint style="info" %}
Earnings events with the Earnings Event value "**Paid Compensation**" signifies payments made to you and should be treated differently than events with the Earnings Event value "**Closed Case**" or "**Referred Partner Earning**". Learn more in our [Example Use Case of Integrating With Accounting/Payroll Tools](https://docs.whiteswan.io/partner-knowledge-base/zapier-integration/example-use-cases/integrate-with-accounting-payroll-tools).
{% endhint %}

***

**Data Returned by the Trigger:**

<table data-full-width="true"><thead><tr><th>Field</th><th>Field Type</th><th>Example Value</th><th>Description</th></tr></thead><tbody><tr><td>Event Message</td><td>Text</td><td>We just recorded another earnings event, Case Closed, for your White Swan account...</td><td>Message detailing the event</td></tr><tr><td>Earnings Event</td><td>Text</td><td>Case Closed</td><td>Type of earnings event</td></tr><tr><td>Referred Partner Name</td><td>Text</td><td>Acme Inc</td><td>Name of the referred partner</td></tr><tr><td>Associated Plan Request ID</td><td>Text</td><td>1670721365811x149164079586738180</td><td>ID of the associated plan request</td></tr><tr><td>Referred Client Name</td><td>Text</td><td>John Doe</td><td>Name of the referred client</td></tr><tr><td>Referred Client Email</td><td>Text</td><td>john@doe.com</td><td>Email of the referred client</td></tr><tr><td>Referred Client Phone Number</td><td>Text</td><td>1234567890</td><td>Phone number of the referred client</td></tr><tr><td>Amount Credited</td><td>Number</td><td>5000</td><td>Amount credited to your account</td></tr><tr><td>Associated Account User</td><td>Text</td><td>Jane Doe</td><td>Name of the associated account user</td></tr><tr><td>Company Credited</td><td>Text</td><td>Doe Services Inc</td><td>Name of the credited company</td></tr><tr><td>Payout Invoice PDF</td><td>Text</td><td>https://s3.amazonaws.com/appforest_uf/f1676518836050x2330177020/doe-services-invoice-4.pdf</td><td>Link to the payout invoice PDF</td></tr></tbody></table>


---

# Agent Instructions: 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:

```
GET https://docs.whiteswan.io/partner-knowledge-base/zapier-integration/triggers/new-earnings-event.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.