Tools
- Attachments (0)
- Page History
- Restrictions
- Info
- Link to this Page…
- View in Hierarchy
- View Wiki Markup

Kayako REST API

{0}."> {0}-{1} of {2} pages containing {3}.">

Skip to end of metadata

Page restrictions apply
Added by Varun Shoor, last edited by Kanika Minhas on Aug 07, 2012 (view change)

Go to start of metadata

Table of contents
1 REST Basics 2 Your helpdesk API URL 3 What a request looks like 4 Authentication 4.1 Generating the signature 5 Testing the API 6 Advanced 6.1 Request URL type 6.2 Arrays 6.3 Response

The Kayako REST API lets you quickly develop applications to connect and integrate into your Kayako helpdesk.

Whether building a custom plugin, connecting Kayako to another app or pulling data from Kayako into your other internal systems, the API lets you retrieve, add and modify data in your helpdesk. Almost every object in Kayako (whether it is a ticket, user, staff, etc) can be manipulated using the API.

REST Basics

A request to the Kayako REST API request is simply an HTTP request with the URL set to the path of the helpdesk module (such as Base), controller (like User) and parameters containing the payload of the request. The Kayako API is a "RESTful web API" (read more about the format on Wikipedia). The API uses plain XML for receiving and dispatching data.

The API uses all four REST commands - GET, PUT, POST, DELETE. These commands correspond to respective actions inside the helpdesk:?

POST and PUT are not interchangeable. Each has a specified function.

Command	Action	Description
`POST`	Create	Create an item (such as a ticket)
`GET`	Retrieve (Read)	Retrieve an item or list of items (such as a list of tickets)
`PUT`	Update	Modify an existing item or list of items (such as changing the owner of an existing ticket)
`DELETE`	Delete	Permanently remove an item or group of items (such as deleting a helpdesk user)

Your helpdesk API URL

Your helpdesk API can be accessed at your-helpdesk-URL/api/. For example:

example.domain.com/path-to-helpdesk/api/

What a request looks like

https://example.domain.com/api/index.php
 ?e=/Module/Controller/Action
 &parameterA=valueA
 &parameterB=valueB
 &parameterC=valueC
 &apikey=d75a00ef-08b6-5b04-5d29-d3b7ca46138a
 &salt=itobgt701t5nat7oor9z4t813edc5t8d
 &signature=MzNiNjk4ZmUyY2FlNjQ5YmRkNjA0YjkyYTQ0NmY5OTQ4MGVkYTIwMzZjMzFkYmJjMzk4MzgzNjNiMzZjYTE4NQ==

Authentication

Permissions
Unlike the Kayako Staff API, the REST API does not require a staff user account to authenticate. The REST API authenticates to the helpdesk using an API key and a secret - using the API key your connecting application has access to all of your helpdesk's data. This means that the REST API has no concept of staff, team or department permissions.

Every request you make to the API must carry with it an API key, a randomly generated salt string and a signature.

Component	Where to find it	Information
API key	In the administrator control panel (under REST API).
Salt	Randomly generated for every request you make to the API.
Signature	Computed by hashing the salt and the secret key for every request you make to the API.	The signature is a SHA256 hash of the salt with the secret key used as the hashing key.
Secret key	In the administrator control panel (under REST API).