Search
K
Contracting & Hierarchies API

ContractUpdatedWebhookEvent

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
Example

ContractDeletedData

object

Payload for the contract.deleted event.

contractIdstring(uuid)required

The unique identifier of the contract.

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

Example

ContractDeletedWebhookEvent

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
Example

ContractResponsiblePartyData

object

Payload for the contract.responsible_party.updated event.

idstring(uuid)required

The unique identifier of the contract responsible party.

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

contractIdstring(uuid)required

The unique identifier of the contract the responsible party belongs to.

Example:110e8400-e29b-41d4-a716-446655440009

contractDisplayNumberstring | null

The display number of the contract the responsible party belongs to.

Example:C-00042

responsiblePartyIdstring(uuid)required

The unique identifier of the party responsible for the contract.

Example:dd0e8400-e29b-41d4-a716-446655440007

startDatestring(date)required

The date the responsible party window begins. Format: yyyy-MM-dd

Example:2024-06-18

endDatestring | null(date)

The date the responsible party window ends; null when the window is open-ended. Format: yyyy-MM-dd

Example

ContractResponsiblePartyUpdatedWebhookEvent

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

Show Child Parameters
Example