Search
K
Contracting & Hierarchies API

HierarchyProducerChangedWebhookEvent

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
Example

HierarchyProducerRelationshipTerminatedData

object

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.

contractAssignmentIdstring(uuid)required

The unique identifier of the contract assignment whose hierarchy relationship ended.

Example:660e8400-e29b-41d4-a716-446655440001

contractIdstring | null(uuid)

The unique identifier of the contract the assignment belongs to.

Example:110e8400-e29b-41d4-a716-446655440009

personIdstring(uuid)required

The unique identifier of the individual producer whose hierarchy relationship ended.

Example:990e8400-e29b-41d4-a716-446655440004

personNpnstring | null

The National Producer Number of the individual producer.

Example:1234567

firmIdstring | null(uuid)

The unique identifier of the firm the producer is contracted under, if any.

firmNpnstring | null

The National Producer Number of the firm, if any.

agencyOrganizationIdstring(uuid)required

The unique identifier of the agency organization the contract is sent from.

Example:770e8400-e29b-41d4-a716-446655440002

carrierOrganizationIdstring(uuid)required

The unique identifier of the carrier organization the contract is sent to.

Example:880e8400-e29b-41d4-a716-446655440003

productIdstring | null(uuid)

The unique identifier of the carrier product the producer is contracted for.

Example:aa0e8400-e29b-41d4-a716-446655440005

writingNumberstring | null

The writing number of the producer’s contract assignment.

Example:0012345

uplineContractAssignmentIdstring | null(uuid)

The unique identifier of the upline contract assignment the producer was placed under.

Example:dd0e8400-e29b-41d4-a716-446655440007

uplineNpnstring | null

The National Producer Number of the upline producer.

Example:7654321

uplineFirmIdstring | null(uuid)

The unique identifier of the upline firm, if any.

uplineFirmNpnstring | null

The National Producer Number of the upline firm, if any.

uplineContractAssignmentOne Of

The curated upline contract assignment identity, if the placement had an upline.

UplineContractAssignmentEventDataobject

Curated, single-level identity of a contract assignment’s upline. The upline is part of the recipient’s own hierarchy; firmName/personName may be null.

Show Child Parameters
commissionLevelIdstring | null(uuid)

The unique identifier of the producer’s commission level.

Example:ee0e8400-e29b-41d4-a716-446655440010

commissionLevelNamestring | null

The name of the producer’s commission level.

Example:Level A

terminationReasonstringrequired

The reason the relationship ended - the name of the terminal assignment
status (e.g. Terminated, Expired, Declined, Withdrawn,
Transferred, Released).

Example:Terminated

terminationDatestring(date)required

The date the relationship ended. Format: yyyy-MM-dd

Example:2024-07-01

createdAtstring | null(date-time)

The date and time the contract assignment was created. Format: RFC3339 UTC.

Example:2024-06-18T09:15:00Z

updatedAtstring | null(date-time)

The date and time the contract assignment was last updated. Format: RFC3339 UTC.

Example:2024-07-01T14:45:00Z

Example

HierarchyProducerRelationshipTerminatedWebhookEvent

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
Example