Order Event

The order event fires every time a service order (Repair Order) is created or updated in myKaarma. The payload mirrors the response from the myKaarma Order API. Full field documentation for the order key is available here.

Field Reference

payloadTop-level payload for the order event.

uuid

string

order

object

The repair order — type, header metadata, vehicle, customer, and labor lines.

type

enum

header

object

vehicle

object

customer

object

jobs[]

array

mls[]

array

{
  "id": "a7b9c1d3-e5f7-4891-ab23-cd45ef678901",
  "timestamp": 1728542293678,
  "dealeruuid": "7c1e5a9f3b7d1e5a9c3e7b1f5d9a3c7e1b5f9d3a7c1e5b9f3d7a1c5e9b3f7d1",
  "departmentuuid": "3a7f1c9e2b5d8f0a4c6e9b1d3f5a7c0e2b4d6f8a1c3e5b7d9f0a2c4e6b8d0f2",
  "type": "service-orders",
  "payload": {
    "uuid": "Gl2eDoAmUjXl9hL4sMrPbIi0QfZwN8OvCdGkBcHntE3",
    "order": {
      "type": "RO",
      "header": {
        "orderNumber": "mykTestRO1122",
        "status": "C",
        "dmsStatus": "O",
        "advisorNumber": "109162",
        "advisorName": "John Smith",
        "dealerAssociateUuid": "4f8b2d6a0e4c8f2b6d0a4c8b2d6f0e4b8d2f6a0c4e8b2d6a0f4c8e2b6d0a4c8",
        "originalAssociateUUID": null,
        "tagNumber": "T205",
        "appointmentNumber": null,
        "mileageIn": "25000",
        "mileageOut": "25012",
        "orderDate": "2025-07-24",
        "orderTime": "22:00:00",
        "closeDate": "2025-09-27",
        "closeTime": "23:28:53",
        "promisedDate": null,
        "promisedTime": null,
        "voidDate": null,
        "waiter": "N",
        "rental": "N",
        "payTypes": "C--",
        "invoiceTotal": null,
        "estimate": null,
        "description": null,
        "stockNumber": null,
        "invoiceURL": null,
        "isInternal": false,
        "isVoided": false,
        "mykCreatedDate": "2025-09-27 23:28:53"
      },
      "vehicle": {
        "uuid": "Pr5jFwQmZnBt8kXaHdV3uI0yDgCeLsR6NvOcTpKqY4f",
        "key": null,
        "vin": "1GD312CG0BF081737",
        "make": "GMC",
        "model": "Sierra 3500HD",
        "color": null,
        "licensePlate": null
      },
      "customer": {
        "uuid": "Wq7nJhXtGpBmNd3KvRzYf2kAcEiLoU8sTPeCbHwOyM1",
        "firstName": "myKaarma",
        "lastName": "Testing",
        "key": null
      },
      "jobs": [
        {
          "jobIdentifier": "A-1",
          "jobNumberString": "A",
          "lopSeqNumber": "1",
          "laborOpCode": "10K",
          "laborOpCodeDesc": "PERFORM 10K SERVICE MAINTENANCE",
          "laborType": "C",
          "dmsLaborType": "CPM",
          "serviceType": "",
          "jobTotal": "488.14",
          "laborSale": "256.50",
          "soldHours": "1.50",
          "actualHours": "1.11",
          "partsSale": "231.64",
          "miscSale": "0.00",
          "shopCharge": null,
          "bookerNo": "109162",
          "dispatchLineStatus": "C93",
          "techNos": "109072",
          "campaignCode": "",
          "addOnLine": "N",
          "estimates": {
            "laborEstimate": null,
            "partsEstimate": null,
            "serviceEstimate": null,
            "taxEstimate": null,
            "lubeEstimate": null,
            "miscEstimate": null,
            "subletEstimate": null
          },
          "parts": [
            {
              "partNumber": "15273825",
              "description": "Engine Oil Filter",
              "seqNo": "1",
              "quantityOrdered": "1",
              "quantitySold": "1",
              "cost": null,
              "salePrice": "12.50",
              "saleTotal": "12.50",
              "laborType": "C"
            }
          ],
          "ccc": {
            "complaint": "Customer reports oil leak",
            "complaintCode": null,
            "cause": "Oil drain plug loose",
            "correction": "Tightened drain plug and refilled oil"
          },
          "comments": [
            {
              "comment": "Checked and adjusted.",
              "lastUpdatedBy": null,
              "updateDate": "2025-09-27",
              "updateTime": "23:28:53"
            }
          ]
        }
      ],
      "mls": [
        {
          "laborType": "C",
          "opCode": "TOW",
          "opCodeDesc": "Towing Service",
          "failureCode": null,
          "salePrice": "75.00",
          "costPrice": null,
          "saleCompany": null,
          "sourceCompany": null,
          "lineCode": null,
          "poNumber": null,
          "poCreateDate": null,
          "poLineID": null,
          "mlsType": null
        }
      ]
    }
  }
}

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.

How to Test an Order Event

1. Login to https://app.mykaarma.com using the user credentials provided to you.

2. In the Customer tab, search for and select the customer you want to create an order for:

   

3. At the top right corner, click on the Create RO button:

   

4. Fill in the RO details (advisor DMS ID is mandatory), then click Save:

   

5. The screen should show the order number of the created Repair Order, and you should receive an event on your webhook URL for the same order.