Operation Event

The operation event fires whenever a labor operation code (opcode) or a service menu/package is created or updated for a dealer. The payload mirrors the Operation document from the kopcode-api repo, serialized in full — every field below is always present in the JSON, with null for values that are not set.

An operation is either a single opcode (operationType: "OPCODE") or a package/menu that bundles several child opcodes. For a package, the child opcodes are carried in invoiceLineList[], each one an object with this same shape.

departmentuuid is null for this event type

Operations belong to a dealer, not to a department. The envelope's departmentuuid therefore arrives as null on operation events, rather than the 64-character identifier shown on the Overview page. Use payload.dealerUuid (or the envelope's dealeruuid) to attribute the operation.

Field Reference

payloadTop-level payload for the operation event — one opcode or one package.

uuid

string

dealerUuid

string

operationType

enum

laborOpCode

stringnullable

opCodeName

stringnullable

menuName

stringnullable

description

stringnullable

customDescription

stringnullable

dmsDescription

stringnullable

cause

stringnullable

correction

stringnullable

notes

stringnullable

category

stringnullable

serviceType

stringnullable

serviceTypeServiceCart

stringnullable

payType

stringnullable

isValid

booleannullable

isDefault

booleannullable

isIndexed

booleannullable

duration

numbernullable

leadTimeInMinutes

numbernullable

soldHours

numbernullable

sortOrder

numbernullable

usagePercentile

numbernullable

dispatchCode

stringnullable

comebackFlag

booleannullable

recallId

stringnullable

quickOpLiteUuid

stringnullable

totalPrice

decimalnullable

laborTotal

decimalnullable

partsTotal

decimalnullable

taxAmount

decimalnullable

miscPrice

stringnullable

dmsTotalPrice

decimalnullable

dmsLaborTotal

decimalnullable

dmsPartsTotal

decimalnullable

dmsTaxAmount

decimalnullable

useDmsPrice

booleannullable

isMkDmsLaborPriceMatching

booleannullable

showDmsPriceMismatchWarning

booleannullable

inMobileService

booleannullable

inOnlineScheduler

booleannullable

inDealerAppScheduler

booleannullable

inServiceCart

booleannullable

inCheckIn

booleannullable

pullEstimateInSC

booleannullable

noPartsNeeded

booleannullable

communicationCodes

arraynullable

invoiceLineList

arraynullable

vehicleMileageConfigList[]

arraynullable

dailyLimitConfigList[]

arraynullable

taxonomyId

number

motorsOperationName

stringnullable

motorsMake

stringnullable

motorsMakeId

number

severityFlag

stringnullable

isSeverityNormal

booleannullable

isSeveritySevere

booleannullable

notesNormal

arraynullable

notesSevere

arraynullable

insertTS

unix msnullable

updateTS

unix msnullable

{
  "id": "a7b9c1d3-e5f7-4891-ab23-cd45ef678901",
  "timestamp": 1728542293678,
  "dealeruuid": "7c1e5a9f3b7d1e5a9c3e7b1f5d9a3c7e1b5f9d3a7c1e5b9f3d7a1c5e9b3f7d1",
  "departmentuuid": null,
  "type": "operations",
  "payload": {
    "uuid": "6bd9c3f1-24ae-4a70-9d51-8e0f7c2b41da",
    "dealerUuid": "cb731d36fd635ddd6ef8dd43500892b0c0249d1c01a46dbcc445a809c0a8e3b2",
    "operationType": "OPCODE",
    "laborOpCode": "BRK15",
    "opCodeName": "Front Brake Service",
    "menuName": null,
    "description": "Inspect and service front brakes",
    "customDescription": null,
    "dmsDescription": "FRONT BRAKE SVC",
    "cause": "",
    "correction": "",
    "notes": null,
    "category": "Brakes",
    "serviceType": "MAINTENANCE",
    "serviceTypeServiceCart": "Mechanical Repair",
    "payType": "CUSTOMER",
    "isValid": true,
    "isDefault": false,
    "isIndexed": true,
    "duration": 60,
    "leadTimeInMinutes": 1440,
    "soldHours": 1.5,
    "sortOrder": 10,
    "usagePercentile": 82,
    "dispatchCode": "B",
    "comebackFlag": false,
    "recallId": null,
    "quickOpLiteUuid": null,
    "totalPrice": 249.95,
    "laborTotal": 150,
    "partsTotal": 89.95,
    "taxAmount": 10,
    "miscPrice": "10.00",
    "dmsTotalPrice": 249.95,
    "dmsLaborTotal": 150,
    "dmsPartsTotal": 89.95,
    "dmsTaxAmount": 10,
    "useDmsPrice": false,
    "isMkDmsLaborPriceMatching": true,
    "showDmsPriceMismatchWarning": false,
    "inMobileService": true,
    "inOnlineScheduler": true,
    "inDealerAppScheduler": true,
    "inServiceCart": false,
    "inCheckIn": false,
    "pullEstimateInSC": false,
    "noPartsNeeded": false,
    "communicationCodes": [
      "BRAKE_SVC"
    ],
    "invoiceLineList": null,
    "vehicleMileageConfigList": [
      {
        "uuid": "7d2b4c81-5f3a-4e19-b06d-3ca9f81e57b4",
        "brand": {
          "id": -1,
          "name": "ALL",
          "motorsMakeId": 0,
          "motorsMakeName": null
        },
        "year": "2023",
        "model": "Explorer",
        "trim": "ALL",
        "engine": "ALL",
        "mileageUuid": "a1c5e93b-7d20-4f68-8b41-2e6d0fa93c57",
        "motorsBaseVehicleId": null,
        "motorsEngineId": null,
        "isValid": true
      }
    ],
    "dailyLimitConfigList": [
      {
        "dayNumber": 0,
        "dayLimit": 2147483647
      }
    ],
    "taxonomyId": 0,
    "motorsOperationName": null,
    "motorsMake": null,
    "motorsMakeId": 0,
    "severityFlag": null,
    "isSeverityNormal": null,
    "isSeveritySevere": null,
    "notesNormal": null,
    "notesSevere": null,
    "insertTS": null,
    "updateTS": 1786071523000
  }
}

note

In the actual webhook delivery, payload is a stringified JSON string (not an object). The example above shows it as a parsed object for readability.