Zoho Desk

this connector will interact with the zoho api to allow swimlane access to create, read and update zoho tickets prerequisites the zoho desk connector asset requires an url , client id , client secret and refresh token to interact with the api capabilities the zoho desk connector has the following capabilities create a ticket get a ticket update a ticket task setup create ticket you can get a department id by going to https //desk zoho com/support/swimlanetest/showhomepage do#setup/general/departments/active and clicking on the department you want in the url address bar, the number at the end of the url is the department id reference documentation please see the following link for any support regarding api functionality https //accounts zoho com/developerconsole https //desk zoho com/deskapidocument#introduction configurations oauth 2 0 client credentials authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required redirect uri redirect uri string required client id the client id provided in the developer portal https //accounts zoho com/developerconsole string required client secret the client secret provided in the developer portal string required org id view an http request in the browser or use the organizations api endpoint https //desk zoho com/api/v1/organizations defaults to first id from api string optional code grant token string optional verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create a ticket it creates a ticket in your helpdesk endpoint url /api/v1/tickets method post input argument name type required description entityskills array optional parameter for create a ticket subcategory string optional parameter for create a ticket cf object optional parameter for create a ticket cf cf permanentaddress object optional parameter for create a ticket cf cf dateofpurchase object optional parameter for create a ticket cf cf phone object optional parameter for create a ticket cf cf numberofitems object optional parameter for create a ticket cf cf url object optional url endpoint for the request cf cf secondaryemail object optional parameter for create a ticket cf cf severitypercentage string optional type of the resource cf cf modelname string optional name of the resource productid string optional unique identifier contactid string optional unique identifier subject string optional parameter for create a ticket departmentid string optional unique identifier contact string optional parameter for create a ticket uploads array optional parameter for create a ticket resolution string optional parameter for create a ticket duedate string optional date value channel string optional parameter for create a ticket description string optional parameter for create a ticket language string optional parameter for create a ticket priority string optional parameter for create a ticket classification string optional parameter for create a ticket responseduedate string optional date value input example {"json body" {"entityskills" \["18921000000379001","18921000000364001","18921000000379055","18921000000379031"],"subcategory" "sub general","cf" {"cf permanentaddress"\ null,"cf dateofpurchase"\ null,"cf phone"\ null,"cf numberofitems"\ null,"cf url"\ null,"cf secondaryemail"\ null,"cf severitypercentage" "0 0","cf modelname" "f3 2017"},"productid" "","contactid" "1892000000042032","subject" "real time analysis requirement","departmentid" "1992000000056007","contact" "","uploads" \["uploads"],"resolution" "resolution","duedate" "2016 06 21t16 16 16 000z","channel" "forums","description" "sample ticket","language" "english","priority" "low","classification" "","responseduedate" "","weburl" "","teamid" "292000000056007","assigneeid" "1892000000056007","phone" "1 888 900 9646","category" "general","secondarycontacts" \["secondarycontacts"],"email" "carol\@zylker com","status" "open"}} output parameter type description status code number http status code of the response reason string response reason phrase entityskills array output field entityskills modifiedtime string time value ticketnumber string output field ticketnumber subcategory string output field subcategory statustype string type of the resource subject string output field subject duedate string date value departmentid string unique identifier channel string output field channel onholdtime object time value description string output field description language string output field language source object output field source source appname object name of the resource source extid object unique identifier source type string type of the resource source permalink object output field source permalink source appphotourl object url endpoint for the request resolution object output field resolution shareddepartments array output field shareddepartments shareddepartments file name string name of the resource shareddepartments file string output field shareddepartments file closedtime object time value output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "thu, 23 nov 2023 20 37 23 gmt"},"reason" "ok","json body" {"entityskills" \["18921000000379001","18921000000364001","18921000000379055"],"modifiedtime" "2016 06 21t12 50 04 000z","ticketnumber" "773","subcategory" "sub general","statustype" "open","subject" "real time analysis requirement","duedate" "2016 06 21t18 50 04 573z","departmentid" "1892000000006907","channel" "email","onholdtime"\ null get a ticket it fetches a single ticket from your helpdesk endpoint url /api/v1/tickets/{{ticket id}} method get input argument name type required description path parameters ticket id string required parameters for the get a ticket action parameters include string optional parameters for the get a ticket action input example {"parameters" {"include" "contacts,products,assignee,departments,team"},"path parameters" {"ticket id" "1892000000143237"}} output parameter type description status code number http status code of the response reason string response reason phrase modifiedtime string time value subcategory string output field subcategory statustype string type of the resource subject string output field subject duedate string date value departmentid string unique identifier channel string output field channel onholdtime object time value language string output field language source object output field source source appname object name of the resource source extid object unique identifier source type string type of the resource source permalink object output field source permalink source appphotourl object url endpoint for the request resolution object output field resolution shareddepartments array output field shareddepartments shareddepartments name string name of the resource shareddepartments id string unique identifier shareddepartments type string type of the resource closedtime object time value sharedcount string count value approvalcount string count value output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "thu, 23 nov 2023 20 37 23 gmt"},"reason" "ok","json body" {"modifiedtime" "2016 06 21t13 16 14 000z","subcategory" "sub general","statustype" "open","subject" "hi there is a sudden delay in the processing of the orders check this with hig ","duedate" "2016 06 21t16 16 16 000z","departmentid" "1892000000006907","channel" "forums","onholdtime"\ null,"language" "english","source" {"appname"\ nu update a ticket it updates an existing ticket endpoint url /api/v1/tickets/{{ticket id}} method patch input argument name type required description path parameters ticket id string required parameters for the update a ticket action parameters disableclosurenotification boolean optional parameters for the update a ticket action entityskills array optional parameter for update a ticket subcategory string optional parameter for update a ticket cf object optional parameter for update a ticket cf cf permanentaddress object optional parameter for update a ticket cf cf dateofpurchase object optional parameter for update a ticket cf cf phone object optional parameter for update a ticket cf cf numberofitems object optional parameter for update a ticket cf cf url object optional url endpoint for the request cf cf secondaryemail object optional parameter for update a ticket cf cf severitypercentage string optional type of the resource cf cf modelname string optional name of the resource productid string optional unique identifier contactid string optional unique identifier subject string optional parameter for update a ticket departmentid string optional unique identifier contact string optional parameter for update a ticket uploads array optional parameter for update a ticket resolution string optional parameter for update a ticket duedate string optional date value channel string optional parameter for update a ticket description string optional parameter for update a ticket language string optional parameter for update a ticket priority string optional parameter for update a ticket input example {"parameters" {"disableclosurenotification"\ true},"json body" {"entityskills" \["18921000000379001","18921000000364001","18921000000379055","18921000000379031"],"subcategory" "sub general","cf" {"cf permanentaddress"\ null,"cf dateofpurchase"\ null,"cf phone"\ null,"cf numberofitems"\ null,"cf url"\ null,"cf secondaryemail"\ null,"cf severitypercentage" "0 0","cf modelname" "f3 2017"},"productid" "","contactid" "1892000000042032","subject" "real time analysis requirement","departmentid" "1992000000056007","contact" "","uploads" \["uploads"],"resolution" "resolution","duedate" "2016 06 21t16 16 16 000z","channel" "forums","description" "sample ticket","language" "english","priority" "low","classification" "","responseduedate" "","weburl" "","teamid" "292000000056007","assigneeid" "1892000000056007","phone" "1 888 900 9646","category" "general","secondarycontacts" \["secondarycontacts"],"email" "carol\@zylker com","status" "open"},"path parameters" {"ticket id" "1892000000143237"}} output parameter type description status code number http status code of the response reason string response reason phrase entityskills array output field entityskills modifiedtime string time value ticketnumber string output field ticketnumber subcategory string output field subcategory statustype string type of the resource subject string output field subject duedate string date value departmentid string unique identifier channel string output field channel onholdtime object time value description string output field description language string output field language source object output field source source appname object name of the resource source extid object unique identifier source type string type of the resource source permalink object output field source permalink source appphotourl object url endpoint for the request resolution object output field resolution shareddepartments array output field shareddepartments shareddepartments file name string name of the resource shareddepartments file string output field shareddepartments file closedtime object time value output example {"status code" 200,"response headers" {"content length" "140","content type" "application/json","date" "thu, 23 nov 2023 20 37 23 gmt"},"reason" "ok","json body" {"entityskills" \["18921000000379001","18921000000364001","18921000000379055"],"modifiedtime" "2016 06 21t12 58 09 122z","ticketnumber" "773","subcategory" "sub general","statustype" "open","subject" "real time analysis requirement","duedate" "2016 06 23t12 58 09 211z","departmentid" "1892000000006907","channel" "forums","onholdtime"\ nul response headers header description example content length the length of the response body in bytes 140 content type the media type of the resource application/json date the date and time at which the message was originated thu, 23 nov 2023 20 37 23 gmt