---
title: "ContractAssignmentUpdatedWebhookEvent"
url: "https://developer.agentsync.io/apis/contracting-hierarchies-api/versions/40f58935-396e-4da4-8f47-1587041e1b16/schemas/ContractAssignmentUpdatedWebhookEvent"
---

> Full API specification: https://developer.agentsync.io/apis/contracting-hierarchies-api/versions/40f58935-396e-4da4-8f47-1587041e1b16.md

# ContractAssignmentUpdatedWebhookEvent

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: AgentSync Contracting & Hierarchies API
  version: v1.7.6
servers:
  - url: https://api.sandbox.agentsync.io/contracting
    description: Sandbox
  - url: https://api.agentsync.io/contracting
    description: Production
components:
  schemas:
    WebhookEventEnvelope:
      title: WebhookEventEnvelope
      type: object
      description: |
        Common wrapper present on every outbound webhook event. The `data` field
        is polymorphic; its schema depends on the value of `type`.
      required:
        - id
        - type
      properties:
        id:
          type: string
          description: |
            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
        type:
          type: string
          description: |
            Dot-notation event type string. Use this field to route the event to
            the appropriate handler in your integration.
          example: contract.assignment.updated
          enum:
            - contract.producer_status.updated
            - contract.assignment.updated
            - contract.assignment.deleted
            - contract.assignment_change.updated
            - contract.assignment_change.deleted
            - contract.packet.submitted
            - contract.updated
            - contract.deleted
            - contract.responsible_party.updated
            - hierarchy.producer.added
            - hierarchy.producer.changed
            - hierarchy.producer.relationship.terminated
    ContractAssignmentUpdatedData:
      title: ContractAssignmentUpdatedData
      type: object
      description: Payload for the `contract.assignment.updated` event.
      required:
        - contractAssignmentId
        - contractId
        - agencyOrganizationId
        - agencyOrganizationName
        - carrierOrganizationId
        - carrierOrganizationName
        - personId
        - productId
        - productName
        - states
        - commissionLevelId
        - commissionLevelName
        - assignmentStatus
        - displayNumber
      properties:
        contractAssignmentId:
          type: string
          format: uuid
          description: The unique identifier of the contract assignment.
          example: 550e8400-e29b-41d4-a716-446655440000
        contractId:
          type: string
          format: uuid
          description: The unique identifier of the contract the assignment belongs to.
          example: 660e8400-e29b-41d4-a716-446655440001
        agencyOrganizationId:
          type: string
          format: uuid
          description: The unique identifier of the agency organization which the contract
            is sent from.
          example: 770e8400-e29b-41d4-a716-446655440002
        agencyOrganizationName:
          type: string
          description: The name of the agency organization which the contract is sent from.
          example: Acme Insurance Agency
        carrierOrganizationId:
          type: string
          format: uuid
          description: The unique identifier of the carrier organization which the
            contract is sent to.
          example: 880e8400-e29b-41d4-a716-446655440003
        carrierOrganizationName:
          type: string
          description: The name of the carrier organization which the contract is sent to.
          example: Big Carrier Inc.
        personId:
          type: string
          format: uuid
          description: The unique identifier of the individual producer which the contract
            is sent on behalf of.
          example: 990e8400-e29b-41d4-a716-446655440004
        personNpn:
          type:
            - string
            - "null"
          description: The National Producer Number of the individual producer.
          example: "1234567"
        firmId:
          type:
            - string
            - "null"
          format: uuid
          description: The unique identifier of the firm which the contract is sent on
            behalf of.
          example: null
        firmNpn:
          type:
            - string
            - "null"
          description: The National Producer Number of the firm.
          example: null
        productId:
          type: string
          format: uuid
          description: The unique identifier of the carrier product assigned to this
            contract with the agency.
          example: aa0e8400-e29b-41d4-a716-446655440005
        productName:
          type: string
          description: The name of the carrier product assigned to this contract with the
            agency.
          example: Term Life
        states:
          type: array
          items:
            type: string
          description: The list of states the contract assignment will be covering.
          example:
            - CA
            - TX
        commissionLevelId:
          type: string
          format: uuid
          description: The unique identifier of the product's commission level assigned to
            this contract.
          example: bb0e8400-e29b-41d4-a716-446655440006
        commissionLevelName:
          type: string
          description: The name of the product's commission level assigned to this contract.
          example: Standard
        assignmentStatus:
          type: string
          description: The status of the contract assignment.
          example: Active
        effectiveDate:
          type:
            - string
            - "null"
          format: date
          description: "The effective date of the contract assignment. Format: yyyy-MM-dd"
          example: 2023-01-15
        requestedEffectiveDate:
          type:
            - string
            - "null"
          format: date
          description: "The requested effective date of the contract assignment. Format:
            yyyy-MM-dd"
          example: null
        submittedDate:
          type:
            - string
            - "null"
          format: date
          description: "The date which the contract assignment was submitted. Format:
            yyyy-MM-dd"
          example: null
        referralCodes:
          type:
            - array
            - "null"
          items:
            type: string
          description: The list of referral codes used by the agency admin to assign the
            contract assignment if it is for portal/carrier website submission.
          example: []
        annualization:
          type:
            - number
            - "null"
          description: The annualization of the contract assignment.
          example: null
        uplineNpn:
          type:
            - string
            - "null"
          description: The National Producer Number of the upline producer for this
            contract assignment.
          example: null
        uplineId:
          type:
            - string
            - "null"
          format: uuid
          description: The unique identifier of the upline producer for this contract
            assignment.
          example: null
        writingNumber:
          type:
            - string
            - "null"
          description: The writing number of the contract assignment.
          example: WN-12345
        displayNumber:
          type: string
          description: The display number of the contract assignment.
          example: CA-00001
        contractDisplayNumber:
          type:
            - string
            - "null"
          description: The display number of the contract the assignment belongs to.
          example: C-00042
        contractAssignmentChangeIds:
          type: array
          items:
            type: string
            format: uuid
          description: The unique identifiers of the contract assignment's non-terminal
            (open) contract assignment changes.
          example:
            - dd0e8400-e29b-41d4-a716-446655440007
        uplineContractAssignment:
          oneOf:
            - $ref: "#/components/schemas/UplineContractAssignmentEventData"
            - type: "null"
          description: The upline contract assignment for this contract assignment, if any.
        responsiblePartyId:
          type:
            - string
            - "null"
          format: uuid
          description: The unique identifier of the producer responsible for this contract
            assignment.
          example: null
        responsibleUplineFirmId:
          type:
            - string
            - "null"
          format: uuid
          description: The unique identifier of the upline firm responsible for this
            contract assignment.
          example: null
        responsibleUplineFirmNpn:
          type:
            - string
            - "null"
          description: The National Producer Number of the upline firm responsible for
            this contract assignment.
          example: null
        responsiblePartyStartDate:
          type:
            - string
            - "null"
          format: date
          description: "The start date of the producer responsible for this contract
            assignment. Format: yyyy-MM-dd"
          example: null
        responsiblePartyEndDate:
          type:
            - string
            - "null"
          format: date
          description: "The end date of the producer responsible for this contract
            assignment. Format: yyyy-MM-dd"
          example: null
        createdAt:
          type:
            - string
            - "null"
          format: date-time
          description: "The date and time the contract assignment was created. Format:
            RFC3339 UTC."
          example: 2024-06-20T14:45:00Z
        updatedAt:
          type:
            - string
            - "null"
          format: date-time
          description: "The date and time the contract assignment was last updated.
            Format: RFC3339 UTC."
          example: 2024-06-20T14:45:00Z
        externalNotes:
          type:
            - string
            - "null"
          description: The external notes of the contract assignment.
          example: null
        debitBalance:
          type:
            - number
            - "null"
          description: The debit balance of the contract assignment. Can be up to 12
            digits and 2 decimal places.
          example: null
        expirationDate:
          type:
            - string
            - "null"
          format: date
          description: "The expiration date of the contract assignment. Format: yyyy-MM-dd"
          example: null
        userDefined1:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined2:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined3:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined4:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined5:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined6:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined7:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined8:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined9:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
        userDefined10:
          type:
            - string
            - "null"
          description: A user defined field of the contract.
    UplineContractAssignmentEventData:
      title: UplineContractAssignmentEventData
      type: object
      description: Curated, single-level identity of a contract assignment's upline.
        The upline is part of the recipient's own hierarchy; firmName/personName
        may be null.
      properties:
        id:
          type: string
          format: uuid
          description: The unique identifier of the upline contract assignment.
          example: cc0e8400-e29b-41d4-a716-446655440008
        displayNumber:
          type:
            - string
            - "null"
          description: The display number of the upline contract assignment.
          example: CA-00009
        firmName:
          type:
            - string
            - "null"
          description: The firm name of the upline contract assignment.
          example: Upline Agency LLC
        personName:
          type:
            - string
            - "null"
          description: The person name of the upline contract assignment.
          example: Jane Doe
    ContractAssignmentUpdatedWebhookEvent:
      title: ContractAssignmentUpdatedWebhookEvent
      allOf:
        - $ref: "#/components/schemas/WebhookEventEnvelope"
        - type: object
          required:
            - data
          properties:
            data:
              $ref: "#/components/schemas/ContractAssignmentUpdatedData"
```