Zendesk API Specification

V 0.1
 Index
Zendesk API Specification .......................................................................................................................... 3
Zendesk API For Single Ticket Creation ................................................................................................. 3
Header ............................................................................................................................................... 3
Header Parameter ............................................................................................................................. 3
Request .............................................................................................................................................. 3
Request Parameter ............................................................................................................................ 4
Response ............................................................................................................................................ 4
Response Parameter .......................................................................................................................... 4
Job Status of Ticket Creation ................................................................................................................. 5
API ...................................................................................................................................................... 5
Header ............................................................................................................................................... 5
Header Parameter ............................................................................................................................. 5
Response ............................................................................................................................................ 5
Response Parameter .......................................................................................................................... 6
Zendesk API Specification
Zendesk API For Single Ticket Creation
Error! Hyperlink reference not valid.

Method Type: POST

Header
Authorization: ${Basic Auth Token}

Header Parameter
Field Type Required Description
Authorization String Yes To authenticate a
request with basic
authentication

Combine your email

address and password
with a colon. Example:
Error! Hyperlink
reference not valid..

Base64-encode the
resulting string.
Example:
amRvZUBleGFtcGxlLm
NvbTpwYSQkdzByZA==.

Request
{
"ticket": {
"comment": {

"html_body": "< <table> <tbody> <tr> <th style='text-align:left'> Reversal Request

Id </th> <td>MFSHUB123 </td> </tr> <tr> <th style='text-align:left'> Partner Code </th>
<td>123 </td> </tr> <tr> <th style='text-align:left'> MFS Transaction Id </th> <td>TD1234
</td> </tr> <tr> <th style='text-align:left'> Amount </th> <td>450 </td> </tr> <tr> <th
style='text-align:left'> Corporate Code </th> <td>MFSPAYZ </td> </tr> <tr> <th style='text-
align:left'> Curbi Partner Code </th> <td>PAYZ </td> </tr> </tbody> </table> "

},

"priority": "urgent",
"subject": "Reversal Request | MFS1045"
 }

Request Parameter
Field Type Required Description
comment object Yes An object that adds a
comment to the ticket.
For more details refer
it comment Details.
comment . html_body string No The comment strings.
priority string No The urgency with which
the ticket should be
addressed. Allowed
values are "urgent",
"high", "normal", or
"low".
subject string No The value of the
subject field for this
ticket

• There was multiple parameters which we can use for specific purposes. check full Details here.

Response
{

"ticket": {

"id": 12

},

"job_status": {

"id": "20a1ddf06ae2cd48cd391feb981ccce5",

"url": "Error! Hyperlink reference not valid.",

"status": "queued",

Response Parameter
 Field Type Required Description
id integer Yes Automatically assigned
when the ticket is
created
job_status Object No Give job details. for Job
Object related follow
this link.
job_status.id string No Automatically assigned
when the job is
queued.
job_status.url string No The URL to poll for
status updates.
job_status.status string No The current status. One
of the following:
"queued", "working",
"failed", "completed",
"killed"
Job Status of Ticket Creation
API

Error! Hyperlink reference not valid. job_statuses/${JOB_ID}.json

Method Type : GET

Header
Authorization: ${Basic Auth Token}

Header Parameter
Field Type Required Description
Authorization String Yes To authenticate a
request with basic
authentication

Combine your email

address and password
with a colon. Example:
Error! Hyperlink
reference not valid..

Base64-encode the
resulting string.
Example:
amRvZUBleGFtcGxlLm
NvbTpwYSQkdzByZA==.
Response
{

"job_status": {

"id": "d2118af049ac98b903e77fee9f663ec8",

"url": "Error! Hyperlink reference not valid.",

"total": 1,

"progress": 1,

"status": "completed",

"message": "Completed at 2022-06-09 09:52:14 +0000",

Response Parameter
Field Type Required Description
job_status Object No Give job details. for Job
Object related follow
this link.
job_status.id string No Automatically assigned
when the job is
queued.
job_status.url string No The URL to poll for
status updates.
job_status.status string No The current status. One
of the following:
"queued", "working",
"failed", "completed",
"killed"
job_status.total integer No The total number of
tasks this job is
batching through.
job_status.progress integer No Number of tasks that
have already been
completed.
job_status.message string No Message from the job
worker, if any.