Contracting & Hierarchies API
contractDeleted
WEBHOOKDelivered when a contract record is permanently deleted. After this
event, the contractId will no longer exist in the system.
post
Body
application/json
Body
application/json
ContractDeletedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Payload for the contract.deleted event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
contractResponsiblePartyUpdated
WEBHOOKDelivered when a contract’s responsible party is created or updated. The
responsible party is the entity accountable for the contract over a date
window; data.startDate and data.endDate bound that window
(endDate is null when the window is open-ended).
post
Body
application/json
Body
application/json
ContractResponsiblePartyUpdatedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Payload for the contract.responsible_party.updated event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
hierarchyProducerAdded
WEBHOOKDelivered when a producer is newly placed under an upline in a hierarchy.
The payload identifies the producer, its upline, and its commission level
at the new placement.
The upline and commission values reflect the new placement; no prior
value is included.
post
Body
application/json
Body
application/json
HierarchyProducerAddedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Shared payload for the hierarchy.producer.added and
hierarchy.producer.changed events. Describes a producer’s placement in a
hierarchy - its upline and commission level - derived from a
contract-assignment change. The upline and commission values reflect the
new placement; no prior value is included. changedFields is present only
on hierarchy.producer.changed.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
hierarchyProducerChanged
WEBHOOKDelivered when an existing producer’s hierarchy position changes - its
upline and/or its commission level. The data.changedFields array lists
which dimensions changed (upline, commissionLevel).
The upline and commission values reflect the new placement; no prior
value is included.
post
Body
application/json
Body
application/json
HierarchyProducerChangedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Shared payload for the hierarchy.producer.added and
hierarchy.producer.changed events. Describes a producer’s placement in a
hierarchy - its upline and commission level - derived from a
contract-assignment change. The upline and commission values reflect the
new placement; no prior value is included. changedFields is present only
on hierarchy.producer.changed.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
hierarchyProducerRelationshipTerminated
WEBHOOKDelivered when a producer’s hierarchy relationship ends - its contract
assignment transitions into a terminal status. The data.terminationReason
is the terminal status name (e.g. Terminated, Expired, Declined) and
data.terminationDate is the date the relationship ended.
The upline and commission values reflect the placement as it existed when
the relationship ended.
post
Body
application/json
Body
application/json
HierarchyProducerRelationshipTerminatedWebhookEvent
Common wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
idstringrequired
Globally unique event identifier. Uses the TypeID format with the
prefix whe_ followed by a UUIDv7-derived suffix
(e.g. whe_01j8e4k2abc123def456). Use this field to deduplicate
deliveries if your endpoint receives the same event more than once.
Example:whe_01j8e4k2abc123def456
typestringrequired
Dot-notation event type string. Use this field to route the event to
the appropriate handler in your integration.
Allowed values:contract.producer_status.updatedcontract.assignment.updatedcontract.assignment.deletedcontract.assignment_change.updatedcontract.assignment_change.deletedcontract.packet.submittedcontract.updatedcontract.deletedcontract.responsible_party.updatedhierarchy.producer.addedhierarchy.producer.changedhierarchy.producer.relationship.terminated
Example:contract.assignment.updated
dataobjectrequired
Payload for the hierarchy.producer.relationship.terminated event. Describes
a producer’s hierarchy placement - its upline and commission level - at the
point its contract assignment transitioned into a terminal status, along with
why (terminationReason) and when (terminationDate). Values reflect the
placement as it existed when the relationship ended; no prior value is included.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200