Search
K
Contracting & Hierarchies API

ContractAssignmentChangeUpdatedWebhookEvent

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
Example

ContractAssignmentChangeDeletedData

object

Payload for the contract.assignment_change.deleted event.

contractAssignmentChangeIdstring(uuid)required

The unique identifier of the contract assignment change.

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

contractAssignmentChangeDisplayNumberstringrequired

The display number of the contract assignment change.

Example:CAC-00001

Example

ContractAssignmentChangeDeletedWebhookEvent

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
Example

Attachment

object

A file attachment included with a contract packet submission.

urlstring

The URL at which the attachment can be retrieved.

Example:https://s3.amazonaws.com/bucket/contract-packet.pdf

fileNamestring

The original file name of the attachment.

Example:contract-packet.pdf

sizestring

The file size of the attachment as a string representation of the byte count.

Example:204800

Example

ContractPacketSubmittedData

object

Payload for the contract.packet.submitted event.

contractPacketIdstring(uuid)required

The unique identifier of the contract packet.

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

submittedByPersonIdstring(uuid)required

The unique identifier of the individual producer which the contract packet is submitted for.

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

submittedByNamestringrequired

The name of the individual producer which the contract packet is submitted for.

Example:Smith, John

submissionDatestring(date-time)required

The timestamp of when the contract packet was submitted. Format: yyyy-MM-dd’T’HH:mm:ss’Z’

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

submissionMethodstringrequired

The method of how the contract packet was submitted.

Example:Email

contractIdstring(uuid)required

The unique identifier of the Contract associated with this packet.

Example:770e8400-e29b-41d4-a716-446655440002

contractNumberstringrequired

The display number of the Contract associated with this packet.

Example:C-00042

attachmentsarray[object]required

A file attachment included with a contract packet submission.

Show Child Parameters
Example