Kayako

Create and track support cases and conversations in Kayako via the Kayako REST API v1.

What It Does

Provides four operations against the Kayako REST API:

Authentication

Kayako uses HTTP Basic Authentication:

Authorization: Basic base64(email:password)

The apiKey input takes the literal email:password string — the tool base64-encodes it before sending.

Getting your credentials: 1. Log in to your Kayako instance as an agent or admin. 2. Use your agent email address and account password. 3. Set instance to your subdomain (e.g. acme for acme.kayako.com).

Inputs

Outputs

Examples

List open cases

{
  "input": {
    "apiKey": "[email protected]:s3cr3t",
    "instance": "acme",
    "operation": "list_cases"
  }
}

Get a specific case

{
  "input": {
    "apiKey": "[email protected]:s3cr3t",
    "instance": "acme",
    "operation": "get_case",
    "caseId": "12345"
  }
}

Create a new internal note case

{
  "input": {
    "apiKey": "[email protected]:s3cr3t",
    "instance": "acme",
    "operation": "create_case",
    "subject": "Server is down",
    "contents": "Customer reported the API is returning 503 errors since 14:00 UTC.",
    "channel": "NOTE",
    "requesterId": "789"
  }
}

Add a reply to an existing case

{
  "input": {
    "apiKey": "[email protected]:s3cr3t",
    "instance": "acme",
    "operation": "reply_case",
    "caseId": "12345",
    "contents": "Thank you for reaching out. We are investigating and will update you shortly."
  }
}

List all posts/messages in a case

{
  "input": {
    "apiKey": "[email protected]:s3cr3t",
    "instance": "acme",
    "operation": "list_posts",
    "caseId": "12345"
  }
}

API Reference

• Base documentation: https://developer.kayako.com/api/v1/reference/introduction/
• Authentication: https://developer.kayako.com/api/v1/reference/authentication/
• Cases: https://developer.kayako.com/api/v1/cases/cases/

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.