Service Connect

Service Connect provides REST APIs for managing follow-up tasks in myKaarma. This includes creating task types, managing templates, creating and fetching follow-ups, and updating follow-up statuses.

To use these endpoints, you first need your credentials. If you don't already have one, please head over to the Authentication and Authorization page to see how you can request for credentials from us.

Prerequisites

Before using the Service Connect APIs, ensure you have:

• Authentication: Valid authorization credentials (Basic Auth or OAuth2)
• Base URL: https://api.mykaarma.com
• Common Headers:
  • accept: application/json
  • Content-Type: application/json
  • authorization: <your-credentials>
• Identifiers Required:
  • Dealer UUID: Unique identifier for the dealer
  • Department UUID: Unique identifier for the dealer's department
  • Customer UUID: Unique identifier for the customer (use the customer search endpoint to find or create customers)
  • User UUID: Unique identifier of the user performing the action

Workflow Overview

The typical workflow for using Service Connect APIs follows these steps:

1. Create Task Type (if not already created) - Define the type of follow-up task (e.g., "Declined Service", "No Show")
2. Check Existing Task Types - Retrieve list of available task types for a dealer
3. Create Template - Create email or text templates for task types
4. View/Update Templates - Manage templates for your task types
5. Create Follow-up - Create a follow-up task for a customer
6. Fetch Follow-ups - Retrieve follow-ups for a dealer (with pagination and filtering)
7. Get Freemarker Data (if using templates) - Retrieve template data for follow-ups
8. Send Message - Use the Communication API to send messages to customers
9. Update Follow-up Status - Mark follow-ups as complete, archive them, or change assignees

API Documentation

📄️ How to create a follow up task type

This endpoint allows you to create a new follow-up task type for a dealer. Task types define the categories of follow-up tasks (e.g., "Declined Service", "No Show", "Missed Appointment").

📄️ How to get task types for a dealer

This endpoint allows you to retrieve all task types configured for a specific dealer.

📄️ How to create a template for follow up task type

This endpoint allows you to create email or text templates for a specific follow-up task type. Templates can be used to standardize messages sent to customers for different types of follow-ups.

📄️ How to get templates for a dealer

This endpoint allows you to retrieve all templates of a specific type (EMAIL or TEXT) for a dealer.

📄️ How to update template for a task type

This endpoint allows you to update an existing template for a follow-up task type.

📄️ How to create a follow up for a customer

This endpoint allows you to create a follow-up task for a specific customer. Follow-ups are used to track and manage customer outreach tasks such as declined services, missed appointments, or other customer engagement activities.

📄️ How to fetch follow ups for a dealer

This endpoint allows you to retrieve follow-ups for a dealer with pagination and filtering capabilities. You can fetch follow-ups in batches using filters such as task type.

📄️ How to get Freemarker data for a followup

This endpoint allows you to retrieve Freemarker template data for follow-ups. Use this when you have templates configured with isFreemarkerTemplate: true and need to get the evaluated template data before sending messages to customers.

📄️ How to update follow ups

This endpoint allows you to update follow-ups to mark them as complete, archive them, or change their assignees.