Copy page

Webhooks

Nested objects

Several objects are embedded inside multiple webhook payloads. This page documents each shared shape once so the event pages can reference it.

team_member

The team_member object identifies a setter, closer, or other staff member. It appears in two context-dependent variants - the field set differs depending on whether the object is embedded in a commission payload or in a sale/refund/lead payload.

Variant A - commission contexts

Carries user_id and roles; no department/is_active.

Code
{
  "object": "team_member",
  "id": "tm_48ceb2c0-962e-4785-9b33-28fb674b4959",
  "user_id": "usr_00000000-0000-0000-0000-000000000000",
  "first_name": "Setter",
  "last_name": "Raghu",
  "email": "sales_setter_p@gmail.com",
  "roles": ["setter"]
}

Field	Type	Nullable	Notes
object	string	No	Always "team_member".
id	string	No	Member UUID, tm_-prefixed.
user_id	string	No	Linked user UUID, usr_-prefixed.
first_name	string	No	Member's first name.
last_name	string	No	Member's last name.
email	string	No	Member's email.
roles	array	No	e.g. ["closer"], ["setter"], ["manager"], ["rev_share"].

Variant B - sale / refund / lead contexts

Carries department and is_active; no user_id.

Code
{
  "object": "team_member",
  "id": "tm_e1454f4d-5042-4a92-bce6-e55f4fb1c10a",
  "first_name": "Jay",
  "last_name": "Test",
  "email": "j.k.kradadiya+saastestcloser@gmail.com",
  "roles": ["closer"],
  "department": "sales",
  "is_active": true
}

Field	Type	Nullable	Notes
object	string	No	Always "team_member".
id	string	No	Member UUID, tm_-prefixed.
first_name	string	No	Member's first name.
last_name	string	No	Member's last name.
email	string	No	Member's email.
roles	array	No	e.g. ["closer","setter"], ["manager","setter"].
department	string	No	e.g. sales.
is_active	boolean	No	Whether the member is active.

payout

Describes the payout schedule and transfer state for a commission.

Code
{
  "date": null,
  "transfer_id": null,
  "paused": false,
  "paused_until": null
}

Field	Type	Nullable	Notes
date	datetime	Yes	Scheduled payout date (ISO 8601), e.g. "2026-07-05T00:00:00Z".
transfer_id	string	Yes	Provider transfer ID once settled, e.g. tr_....
paused	boolean	No	Whether the payout is paused.
paused_until	datetime	Yes	When the pause lifts (ISO 8601).

platform_fee

The platform fee breakdown attached to a sale.

Code
{
  "total_amount": 0,
  "business_amount": 0,
  "team_amount": 0,
  "total_percent": 1.0
}

Field	Type	Nullable	Notes
total_amount	float	No	Total platform fee amount.
business_amount	float	No	Portion charged to the business.
team_amount	float	No	Portion charged to the team.
total_percent	float	No	Fee as a percentage.

bnpl

Buy-now-pay-later breakdown attached to a sale.

Code
{
  "provider": "Random",
  "percentage": 11.0,
  "fee_amount": 1100.0,
  "gross_revenue": 10000.0,
  "net_revenue": 8900.0
}

Field	Type	Nullable	Notes
provider	string	Yes	BNPL provider name.
percentage	float	No	BNPL fee percentage.
fee_amount	float	No	BNPL fee amount.
gross_revenue	float	No	Gross revenue before BNPL fee.
net_revenue	float	No	Net revenue after BNPL fee.

installment

A single installment record, embedded in commission and sale payloads when a payment is part of an installment plan.

Code
{
  "id": "ins_00000000-0000-0000-0000-000000000000",
  "type": "down_payment",
  "payment_date": "2026-07-05",
  "amount": 1000,
  "currency": "usd",
  "status": "paid"
}

Field	Type	Nullable	Notes
id	string	No	Installment record ID.
type	string	No	Installment type, e.g. down_payment.
payment_date	date	No	Scheduled or actual payment date.
amount	integer	No	Installment amount.
currency	string	No	Currency code.
status	string	No	Installment status, e.g. paid, pending.

crm

CRM sync metadata, embedded in lead payloads.

Code
{
  "source": "gohighlevel",
  "source_id": "SQH6L2RCqM1NvscXHYGi",
  "synced": true
}

Field	Type	Nullable	Notes
source	string	Yes	CRM source name, e.g. gohighlevel. null when unsynced.
source_id	string	Yes	Record ID in the source CRM.
synced	boolean	No	Whether the record is synced to the CRM.