Webhook Events

myKaarma publishes events whenever a customer, appointment, service order, MPI, message, 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.

📄️ 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.