Extensions can make use of Log API to log the extension processes. Logs can be viewed on customer's support portal.
Logs will expire after 3days.
Path to Logs:
Parent Logs:
SubLogs List:
During development, logs are loaded in the developer's portal.
The param - reference is a random string that is used to group multiple logs. If multiple logs are grouped using reference, the first log will be the parent log and the rest will be sub logs. Developer can group a maximum of 10 logs using a reference. Means, a parent log can have 9 sub logs as maximum.
If the logs are created without reference, they are considered as parent logs.
The available APIs for Logs are
- Add a Log
#EXTENSION_LOG_OBJECT
#EXTENSION_LOG_OBJECT
- {
- "reference" : "1d8bd6c8-5424-11e8-9c2d-fa7ae01bbebc",
- "description" : "jira issue is created with id = 10223",
- "installationId" : "112343231355",
- "title" : "created a jira issue"
- }
#LOG_API_RESPONSE_OBJECT
- {
- "parentLogId" : "4000000022003",
- "extensionName" : "Jira",
- "description" : "jira issue is created with id = 10223",
- "logId" : "4000000023001",
- "installationId" : "112343231355",
- "title" : "create jira issue",
- "logTime" : "2018-05-10T07:33:13.000Z"
- }
Add a Log
Use this API to add extension logs.
Request Format:
URL : api/v1/extensionLogs
OAuth Scope : Desk.extensions.CREATE
RequestMethod : POST
RequestHeaders : orgId, Authorization
Content-Type : application/json
RequestBody : #EXTENSION_LOG_OBJECT.
Response Format:
ResponseCode : 200
Content-Type : application/json
Response : #LOG_API_RESPONSE_OBJECT