ContractDeletedData
objectPayload for the contract.deleted event.
The unique identifier of the contract.
Example:550e8400-e29b-41d4-a716-446655440000
ContractDeletedWebhookEvent
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
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
Payload for the contract.deleted event.
Show Child Parameters
ContractResponsiblePartyData
objectPayload for the contract.responsible_party.updated event.
The unique identifier of the contract responsible party.
Example:550e8400-e29b-41d4-a716-446655440000
The unique identifier of the contract the responsible party belongs to.
Example:110e8400-e29b-41d4-a716-446655440009
The display number of the contract the responsible party belongs to.
Example:C-00042
The unique identifier of the party responsible for the contract.
Example:dd0e8400-e29b-41d4-a716-446655440007
The date the responsible party window begins. Format: yyyy-MM-dd
Example:2024-06-18
The date the responsible party window ends; null when the window is open-ended. Format: yyyy-MM-dd
ContractResponsiblePartyUpdatedWebhookEvent
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
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
Payload for the contract.responsible_party.updated event.
Show Child Parameters
HierarchyProducerEventData
objectShared 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.
The unique identifier of the contract assignment change that drove this hierarchy event.
Example:550e8400-e29b-41d4-a716-446655440000
The unique identifier of the contract assignment the producer holds in the hierarchy.
Example:660e8400-e29b-41d4-a716-446655440001
The unique identifier of the contract the assignment belongs to.
Example:110e8400-e29b-41d4-a716-446655440009
The unique identifier of the individual producer whose hierarchy placement changed.
Example:990e8400-e29b-41d4-a716-446655440004
The National Producer Number of the individual producer.
Example:1234567
The unique identifier of the firm the producer is contracted under, if any.
The National Producer Number of the firm, if any.
The unique identifier of the agency organization the contract is sent from.
Example:770e8400-e29b-41d4-a716-446655440002
The unique identifier of the carrier organization the contract is sent to.
Example:880e8400-e29b-41d4-a716-446655440003
The unique identifier of the carrier product the producer is contracted for.
Example:aa0e8400-e29b-41d4-a716-446655440005
The writing number of the producer’s contract assignment.
Example:0012345
The unique identifier of the upline contract assignment the producer is placed under.
Example:dd0e8400-e29b-41d4-a716-446655440007
The National Producer Number of the upline producer.
Example:7654321
The unique identifier of the upline firm, if any.
The National Producer Number of the upline firm, if any.
One OfThe curated upline contract assignment change identity, if the placement has an upline.
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
The unique identifier of the producer’s commission level.
Example:ee0e8400-e29b-41d4-a716-446655440010
The name of the producer’s commission level.
Example:Level A
The name of the producer’s assignment status.
Example:Active
The effective date of the placement. Format: yyyy-MM-dd
Example:2024-06-18
The hierarchy dimensions this change affected (upline,
commissionLevel). Present on hierarchy.producer.changed; absent on
hierarchy.producer.added.
Example:upline, commissionLevel
The date and time the underlying change was created. Format: RFC3339 UTC.
Example:2024-06-18T09:15:00Z
The date and time the underlying change was last updated. Format: RFC3339 UTC.
Example:2024-06-20T14:45:00Z