Search
K
Contracting & Hierarchies API

UplineContractAssignmentChangeEventData

object

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

idstring(uuid)

The unique identifier of the upline contract assignment change.

Example:cc0e8400-e29b-41d4-a716-446655440008

displayNumberstring | null

The display number of the upline contract assignment change.

Example:CAC-00009

firmNamestring | null

The firm name of the upline contract assignment change.

Example:Upline Agency LLC

personNamestring | null

The person name of the upline contract assignment change.

Example:Jane Doe

Example

ContractAssignmentChangeUpdatedData

object

Payload for the contract.assignment_change.updated event.

contractAssignmentChangeIdstring(uuid)required

The unique identifier of the contract assignment change.

Example:550e8400-e29b-41d4-a716-446655440000

contractAssignmentIdstring(uuid)required

The unique identifier of the contract assignment associated with this change.

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

agencyOrganizationIdstring(uuid)required

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

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

agencyOrganizationNamestringrequired

The name of the agency organization which the contract is sent from.

Example:Acme Insurance Agency

carrierOrganizationIdstring(uuid)required

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

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

carrierOrganizationNamestringrequired

The name of the carrier organization which the contract is sent to.

Example:Big Carrier Inc.

productIdstring(uuid)required

The unique identifier of the carrier product assigned to this contract change with the agency.

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

productNamestringrequired

The name of the carrier product assigned to this contract change with the agency.

Example:Term Life

personIdstring(uuid)required

The unique identifier of the individual producer which the contract assignment change is for.

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 which the contract assignment change is for.

firmNpnstring | null

The National Producer Number of the firm.

statesarray[string]required

The list of states associated with the contract assignment change.

Example:CA

newAnnualizationnumber | null

The decimal value of the new annualization associated with this change.

newAssignmentStatusNamestring | null

The name of the new assignment status associated with this change.

Example:Active

newCommissionLevelIdstring | null(uuid)

The unique identifier of the new commission level associated with this change.

newCommissionLevelNamestring | null

The name of the new commission level associated with this change.

newUplineContractAssignmentIdstring | null(uuid)

The unique identifier of the new upline contract assignment associated with this change.

newUplineNpnstring | null

The National Producer Number of the new upline producer associated with this change.

uplineContractAssignmentChangeIdstring | null(uuid)

The unique identifier of the upline contract assignment change associated with this change.

uplineContractAssignmentChangeDisplayNumberstring | null

The display number of the upline contract assignment associated with this change.

responsibleUplineFirmNpnstring | null

The National Producer Number of the upline firm responsible for this contract assignment.

uplineContractAssignmentChangeOne Of

The upline contract assignment change for this change, if any.

UplineContractAssignmentChangeEventDataobject

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

Show Child Parameters
contractPacketIdstring(uuid)required

The unique identifier of the contract packet associated with this change.

Example:bb0e8400-e29b-41d4-a716-446655440006

taskTypeNamestringrequired

The name of the task type intended by this change.

Example:New Business

referralCodesarray[string]required

The list of referral codes used by the agency admin to assign the contract assignment change if it is for portal/carrier website submission.

Example:[]

titlestring | null

The title/name of the contract assignment change.

effectiveDatestring | null(date)

The effective date of the contract assignment change. Format: yyyy-MM-dd

expirationDatestring | null(date)

The expiration date of the contract assignment change. Format: yyyy-MM-dd

contractAssignmentChangeDisplayNumberstringrequired

The display number of the contract assignment change.

Example:CAC-00001

writingNumberstring | null

The writing number of the contract assignment associated with this change.

Example:WN-12345

createdAtstring | null(date-time)

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

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

updatedAtstring | null(date-time)

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

Example:2024-06-20T14:45:00Z

externalNotesstring | null

The external notes of the contract assignment change.

uplineFirmIdstring | null(uuid)

The unique identifier of the upline firm associated with this change.

uplineFirmNpnstring | null

The National Producer Number of the upline firm associated with this change.

uplineWritingNumberstring | null

The writing number of the upline contract assignment associated with this change.

userDefined1string | null

A user defined field of the contract assignment change.

userDefined2string | null

A user defined field of the contract assignment change.

userDefined3string | null

A user defined field of the contract assignment change.

userDefined4string | null

A user defined field of the contract assignment change.

userDefined5string | null

A user defined field of the contract assignment change.

userDefined6string | null

A user defined field of the contract assignment change.

userDefined7string | null

A user defined field of the contract assignment change.

userDefined8string | null

A user defined field of the contract assignment change.

userDefined9string | null

A user defined field of the contract assignment change.

userDefined10string | null

A user defined field of the contract assignment change.

Example

ContractAssignmentChangeUpdatedWebhookEvent

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.assignment_change.updated event.

Show Child Parameters
Example

ContractAssignmentChangeDeletedData

object

Payload for the contract.assignment_change.deleted event.

contractAssignmentChangeIdstring(uuid)required

The unique identifier of the contract assignment change.

Example:550e8400-e29b-41d4-a716-446655440000

contractAssignmentChangeDisplayNumberstringrequired

The display number of the contract assignment change.

Example:CAC-00001

Example

ContractAssignmentChangeDeletedWebhookEvent

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.assignment_change.deleted event.

Show Child Parameters
Example