New Earnings Event

This event happens 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.

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.

---

Sample Payload

{
"event_message": "We just recorded another earnings event, Case Closed, for your White Swan account, with a total crediting amount of $5,000. To follow your earnings, you can visit https://app.whiteswan.io/earnings/acme-inc",
"event_type": "Case Closed",
"associated_partner_referral": "Acme Inc",
"associated_request_id": "1670721365811x149164079586738180",
"associated_client_name": "John Doe",
"associated_client_email": "[e-mail]",
"associated_client_phone": "1234567890",
"amount_credited": 5000,
"case_associated_account_user": "Jane Doe",
"case_associated_partner_company": "Doe Services Inc",
"credit_invoice_pdf": "https://s3.amazonaws.com/appforest_uf/f1676518836050x2330177020/doe-services-invoice-4.pdf"
}

Data Returned by this Event:

Field Label	Field Key	Field Type	Example Value	Description
Event Message	event_message	Text	We just recorded another earnings event, Case Closed, for your White Swan account...	Message detailing the event
Earnings Event	event_type	Text	Case Closed	Type of earnings event
Referred Partner Name	associated_partner_referral	Text	Acme Inc	Name of the referred partner
Associated Plan Request ID	associated_request_id	Text	1670721365811x149164079586738180	ID of the associated plan request
Referred Client Name	associated_client_name	Text	John Doe	Name of the referred client
Referred Client Email	associated_client_email	Text	[e-mail]	Email of the referred client
Referred Client Phone Number	associated_client_phone	Text	1234567890	Phone number of the referred client
Amount Credited	amount_credited	Number	5000	Amount credited to your account
Associated Account User	case_associated_account_user	Text	Jane Doe	Name of the associated account user
Company Credited	case_associated_partner_company	Text	Doe Services Inc	Name of the credited company
Payout Invoice PDF	credit_invoice_pdf	Text	https://s3.amazonaws.com/appforest_uf/f1676518836050x2330177020/doe-services-invoice-4.pdf	Link to the payout invoice PDF