Webhook Events
myKaarma publishes events whenever a customer, appointment, mobile service appointment, service order, MPI, message, operation, dealer associate, or opt-out status changes. Choose an event type below to see its full field reference and example payload.
๐๏ธ Customer Event
The customer event fires every time a customer record is created or updated in myKaarma. The payload mirrors the response from the myKaarma Customer API. Full field documentation for customerWithVehicles is also available here.
๐๏ธ Appointment Event
The appointment event fires every time an appointment is created, updated, or deleted in myKaarma. The payload extends the myKaarma Appointment API response โ full field documentation for appointmentInfoResponse is available here.
๐๏ธ 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.
๐๏ธ MPI Event
The MPI (Multipoint Inspection) event fires every time an MPI is created or updated in myKaarma. The payload mirrors the MPI object available via the myKaarma MPI API.
๐๏ธ Message Event
The message event fires every time a message is sent or received in myKaarma, or when an existing message is updated. This covers all communication channels โ text (SMS), email, voice calls, WhatsApp, and internal notes.
๐๏ธ Mobile Service Appointment Event
The mobile service appointment event fires when a Mobile Service appointment (a technician dispatched to service a vehicle at the customer's location) is created, updated, cancelled, declined, or completed. The payload mirrors ServiceAppointmentDTO from the mobile-service repo โ field content below is verified against two live production events (one CREATED, one UPDATED).
๐๏ธ Opt-Out Status Event
The opt-out status event is not available for webhook subscriptions yet. The payload contract is documented here so API partners can prepare their read-only integration.
๐๏ธ 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.
๐๏ธ Dealer Associate Event
The dealer associate event fires whenever a dealer associate (a dealership employee โ service advisor, technician, manager, and so on) is created or updated. The payload mirrors DealerAssociateTransitionEventPayload from the kmanage-api repo.