Search
K
Contracting & Hierarchies API

ContractUpdatedData

object

Payload for the contract.updated event.

contractIdstring(uuid)required

The unique identifier of the contract.

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

agencyOrganizationIdstring(uuid)required

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

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

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:770e8400-e29b-41d4-a716-446655440002

carrierOrganizationNamestringrequired

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

Example:Big Carrier Inc.

personIdstring(uuid)required

The unique identifier of the individual producer which the contract is sent on behalf of.

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

personNpnstring | null

The National Producer Number of the individual producer.

Example:1234567

firmIdstring | null(uuid)

The unique identifier of the firm which the contract is sent on behalf of.

firmNpnstring | null

The National Producer Number of the firm.

responsibleUplineFirmIdstring | null(uuid)

The unique identifier of the upline firm responsible for this contract.

responsibleUplineFirmNpnstring | null

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

assignmentStatusIdstring | null(uuid)

The unique identifier of the assignment status which the contract is in.

assignmentStatusNamestring | null

The assignment status of the contract.

Example:Active

activebooleanrequired

Denotes if the contract is currently active based on the status of its contract assignments.

Example:true

effectiveDatestring(date)required

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

Example:2023-01-15

endDatestring | null(date)

The end date of the contract. Format: yyyy-MM-dd

contractCompletionDatestring | null(date)

The date contracting completed for this contract, from its latest active contract assignment. Format: yyyy-MM-dd

Example:2024-03-01

transferAvailableDatestring | null(date)

The date this contract becomes available to transfer, from its latest active contract assignment. Format: yyyy-MM-dd

Example:2025-03-01

notesstring | null

Internal notes visible to the agency, from the contract’s latest active contract assignment. Distinct from the externally visible notes (externalNotes) carried by the contract assignment events.

Example:Awaiting appointment confirmation from the carrier.

statesarray[string]

The administrative divisions (state abbreviations) covered by the contract’s active contract assignments. Empty when the contract has no active assignments.

Example:CA, TX

createdAtstring | null(date-time)

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

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

updatedAtstring | null(date-time)

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

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

displayNumberstring | null

The display number of the contract.

Example:C-00042

parentContractIdstring | null(uuid)

The unique identifier of the parent contract, if this is a subsidiary contract.

parentContractDisplayNumberstring | null

The display number of the parent contract, if this is a subsidiary contract.

userDefined1string | null

A user defined field of the contract.

userDefined2string | null

A user defined field of the contract.

userDefined3string | null

A user defined field of the contract.

userDefined4string | null

A user defined field of the contract.

userDefined5string | null

A user defined field of the contract.

userDefined6string | null

A user defined field of the contract.

userDefined7string | null

A user defined field of the contract.

userDefined8string | null

A user defined field of the contract.

userDefined9string | null

A user defined field of the contract.

userDefined10string | null

A user defined field of the contract.

Example

ContractUpdatedWebhookEvent

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

Show Child Parameters
Example

ContractDeletedData

object

Payload for the contract.deleted event.

contractIdstring(uuid)required

The unique identifier of the contract.

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

Example

ContractDeletedWebhookEvent

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
Example

ContractResponsiblePartyData

object

Payload for the contract.responsible_party.updated event.

idstring(uuid)required

The unique identifier of the contract responsible party.

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

contractIdstring(uuid)required

The unique identifier of the contract the responsible party belongs to.

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

contractDisplayNumberstring | null

The display number of the contract the responsible party belongs to.

Example:C-00042

responsiblePartyIdstring(uuid)required

The unique identifier of the party responsible for the contract.

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

startDatestring(date)required

The date the responsible party window begins. Format: yyyy-MM-dd

Example:2024-06-18

endDatestring | null(date)

The date the responsible party window ends; null when the window is open-ended. Format: yyyy-MM-dd

Example