Contracting & Hierarchies API
contractAssignmentChangeUpdated
WEBHOOKDelivered when a contract assignment change record is created or updated.
A contract assignment change is a point-in-time snapshot of the desired
state for one or more aspects of a contract assignment (e.g. a new
commission level, a new upline, a status promotion).
Changes are grouped into contract packets for carrier submission. The
data.contractPacketId links this change to its submission packet.
post
Body
application/json
Body
application/json
ContractAssignmentChangeUpdatedWebhookEvent
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.assignment_change.updated event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
contractAssignmentChangeDeleted
WEBHOOKDelivered when a contract assignment change record is permanently deleted.
After this event, the contractAssignmentChangeId will no longer exist
in the system.
post
Body
application/json
Body
application/json
ContractAssignmentChangeDeletedWebhookEvent
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.assignment_change.deleted event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
contractPacketSubmitted
WEBHOOKDelivered when a contract packet is submitted to a carrier. A contract
packet is a collection of contract assignment changes bundled together
for a single carrier submission.
The data.submissionMethod describes how the packet was delivered (e.g.
email, portal, direct API). The data.attachments list contains the
submitted documents if any were included.
post
Body
application/json
Body
application/json
ContractPacketSubmittedWebhookEvent
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.packet.submitted event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
contractUpdated
WEBHOOKDelivered when a contract record is created or updated. A contract is
the underlying agreement between an agency and a carrier on behalf of a
producer. It groups one or more contract assignments for the same
agency–carrier–producer combination.
This event also fires when a contract is first created.
post
Body
application/json
Body
application/json
ContractUpdatedWebhookEvent
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.updated event.
Show Child Parameters
Response
200
Response
200
Customer endpoint acknowledged the event.
200
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