ApiError
objectThe AgentSync error shape.
A human-readable description of the error.
Optional field-level details.
Show Child Parameters
WebhookEventEnvelope
objectCommon wrapper present on every outbound webhook event. The data field
is polymorphic; its schema depends on the value of type.
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
ProducerStatusUpdatedData
objectPayload for the contract.producer_status.updated event.
The unique identifier of the producer.
Example:550e8400-e29b-41d4-a716-446655440000
The National Producer Number of the producer.
Example:1234567
The unique identifier of the organization which the producer’s role and status has been updated for.
Example:660e8400-e29b-41d4-a716-446655440001
The name of the organization which the producer’s role and status has been updated for.
Example:Acme Insurance Agency
The date of when the producer started with their organization. Format: yyyy-MM-dd
Example:2023-01-15
The date of when the producer ended with their organization. Format: yyyy-MM-dd
The unique identifier of the status of the producer.
Example:770e8400-e29b-41d4-a716-446655440002
The name of the status of the producer.
Example:Active
Denotes if the producer is currently active with their organization.
Example:true
Timestamp of when this record was last updated. Format: yyyy-MM-dd’T’HH:mm:ss’Z’
Example:2024-06-20T14:45:00Z
The date the producer was hired by their organization. Format: yyyy-MM-dd
Example:2023-01-15
ProducerStatusUpdatedWebhookEvent
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.producer_status.updated event.
Show Child Parameters
UplineContractAssignmentEventData
objectCurated, single-level identity of a contract assignment’s upline. The upline is part of the recipient’s own hierarchy; firmName/personName may be null.
The unique identifier of the upline contract assignment.
Example:cc0e8400-e29b-41d4-a716-446655440008
The display number of the upline contract assignment.
Example:CA-00009
The firm name of the upline contract assignment.
Example:Upline Agency LLC
The person name of the upline contract assignment.
Example:Jane Doe