Search
K
Contracting & Hierarchies API

contractProducerStatusUpdated

WEBHOOK

Delivered when a producer’s role status is created or updated within an
organization. Fires on both the initial assignment of a status and any
subsequent change.

The data.organizationId field identifies the agency or carrier
organization whose producer hierarchy was affected.

post

Body

application/json

ProducerStatusUpdatedWebhookEvent

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

Show Child Parameters

Response

200

Customer endpoint acknowledged the event.

200

contractAssignmentUpdated

WEBHOOK

Delivered when a contract assignment is created or updated. This event
fires for both new assignments and any modification to an existing
assignment (status change, commission level change, writing number
assignment, etc.).

The data.agencyOrganizationId identifies the agency that owns the
assignment. The data.contractAssignmentId is stable across updates
and can be used to correlate events for the same record.

post

Body

application/json

ContractAssignmentUpdatedWebhookEvent

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

Show Child Parameters

Response

200

Customer endpoint acknowledged the event.

200

contractAssignmentDeleted

WEBHOOK

Delivered when a contract assignment is permanently deleted. After this
event, the contractAssignmentId will no longer exist in the system.

Only the contractAssignmentId and displayNumber are included because
no other state is meaningful once the record is gone.

post

Body

application/json

ContractAssignmentDeletedWebhookEvent

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

Show Child Parameters

Response

200

Customer endpoint acknowledged the event.

200

contractAssignmentChangeUpdated

WEBHOOK

Delivered 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

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

Customer endpoint acknowledged the event.

200

contractAssignmentChangeDeleted

WEBHOOK

Delivered 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

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

Customer endpoint acknowledged the event.

200