Zendesk Ticket Management

the zendesk ticket management connector allows for streamlined interaction with zendesk's support ticket system, enabling automated ticket handling and customer support processes zendesk is a customer service platform designed to foster better customer relationships through efficient ticket management and support services the zendesk ticket management connector for swimlane turbine enables users to automate ticket creation, management, and analysis directly within the swimlane ecosystem by integrating with zendesk, security teams can streamline incident response, manage customer support tickets, and enhance collaboration between it and customer service departments this connector empowers users to perform a wide range of actions, from ticket creation and updates to comment redaction and file uploads, all without leaving the swimlane platform zendesk connector integrates with zendesk ticketing api's to process, manage, and track customer issues/tickets from submission to resolution prerequisites to effectively utilize the zendesk ticket management connector with swimlane turbine, ensure you have the following prerequisites http basic authentication with these parameters url the endpoint for zendesk api access email id the email address associated with your zendesk account password the password for your zendesk account oauth 2 0 password credentials with these parameters url the endpoint for zendesk api access email id the email address associated with your zendesk account password the password for your zendesk account client id the client identifier for oauth authentication scopes the scopes of access requested for the oauth token custom authentication with these parameters url the endpoint for zendesk api access email id the email address associated with your zendesk account api token a unique token used for api access in lieu of a password configuring an asset host ( required ) = the hostname of the product's api authentication type ( required ) = type of authentication to use for this api options http basic , custom , oauth2 password verify ssl = toggle ssl verification support http proxy = a proxy url where all requests can get routed through basic authentication this means you have select authentication type to be http basic email id ( required ) = the account email id password ( required ) = the account password custom token authentication this means you have select authentication type to be custom email id ( required ) = the account email id api token ( required ) = value of the api token oauth2 0 password authentication this means you have select authentication type to be oauth2 password oauth2 client id ( required ) = client id email id ( required ) = account email id password ( required ) = account password scopes ( required ) = space separated string of scopes to apply to the access token capabilities this connector provides the following capabilities create ticket delete ticket list comments list custom ticket statuses list recent tickets list tickets list tickets by organisation list tickets by user status redact comment attachment show ticket update attachment for malware update custom ticket status update many tickets in batch update many tickets in bulk update ticket and so on action setup upload files action create playbook with upload files action from zendesk connector open upload files action and select playbook input attachments to form data files input and select other required values and asset trigger playbook from upstream actions or applications by passing attachment api specific links list tickets https //developer zendesk com/api reference/ticketing/tickets/tickets/#list ticketscreate ticket https //developer zendesk com/api reference/ticketing/tickets/tickets/#create ticketupdate ticket https //developer zendesk com/api reference/ticketing/tickets/tickets/#update ticketupdate many tickets https //developer zendesk com/api reference/ticketing/tickets/tickets/#update many ticketsdelete ticket https //developer zendesk com/api reference/ticketing/tickets/tickets/#delete ticketlist custom ticket statuses https //developer zendesk com/api reference/ticketing/tickets/custom ticket statuses/#list custom ticket statusesupdate custom ticket status https //developer zendesk com/api reference/ticketing/tickets/custom ticket statuses/#update custom ticket statusupload files https //developer zendesk com/api reference/ticketing/tickets/ticket attachments/#upload filesupdate attachment for malware https //developer zendesk com/api reference/ticketing/tickets/ticket attachments/#update attachment for malwareredact comment attachment https //developer zendesk com/api reference/ticketing/tickets/ticket attachments/#redact comment attachment configurations zendesk api custom token authentication authenticates using username and api token configuration parameters parameter description type required url a url to the target host string required username account email id string required apitoken api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional zendesk api http basic authentication authenticates using username and password configuration parameters parameter description type required url a url to the target host string required username account email id string required password account password string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional zendesk api oauth 2 0 password grant authenticates using oauth 2 0 client credentials configuration parameters parameter description type required url a url to the target host string required oauth2 username the email id of account string required oauth2 password the password for account string required client id the client id number required scope permission scopes for this action array required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions create ticket create a new ticket in zendesk with specified properties, requiring a 'ticket' object in the json body endpoint url /api/v2/tickets method post input argument name type required description ticket object required parameter for create ticket comment object required parameter for create ticket body string optional request body data priority string optional parameter for create ticket subject string optional parameter for create ticket output parameter type description status code number http status code of the response reason string response reason phrase ticket object output field ticket url string url endpoint for the request id number unique identifier external id object unique identifier via object output field via channel string output field channel source object output field source from object output field from to object output field to rel object output field rel created at string output field created at updated at string output field updated at type object type of the resource subject string output field subject raw subject string output field raw subject description string output field description priority string output field priority status string status value recipient object output field recipient requester id number unique identifier submitter id number unique identifier assignee id number unique identifier organization id number unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "ticket" {}, "audit" {} } } ] delete ticket deletes a specified ticket from zendesk using the provided ticket id endpoint url /api/v2/tickets/{{ticket id}} method delete input argument name type required description ticket id number required the id of the ticket output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text example \[ { "status code" 204, "response headers" { "date" "mon, 05 feb 2024 07 47 20 gmt", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19886", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "41", "strict transport security" "max age=31536000; includesubdomains", "cache control" "no cache", "set cookie" " zendesk cookie=bahjihl7imrldmljzv90b2tlbnmiont9fqy6bkvu 0bf2100788cb010d0183fe ", "x zendesk origin server" "classic app server 65b948b6 lxqnh", "x request id" "85098b6d1deef46a bom, 85098b6d1deef46a bom" }, "reason" "no content", "response text" "" } ] list comments retrieve all comments from a specified ticket in zendesk, including urls for attachments and external voice recordings endpoint url /api/v2/tickets/{{ticket id}}/comments method get input argument name type required description ticket id number required the id of the ticket include string optional accepts "users" use this parameter to list email ccs by side loading users example ?include=users note if the comment source is email, a deleted user will be represented as the ccd email address if the comment source is anything else, a deleted user will be represented as the user name include inline images boolean optional default is false when true, inline images are also listed as attachments in the response sort string optional possible values are "created at" (ascending order) or " created at" (descending order) sort order string optional one of asc, desc defaults to asc output parameter type description status code number http status code of the response reason string response reason phrase comments array output field comments attachments array output field attachments audit id number unique identifier author id number unique identifier body string request body data created at string output field created at id number unique identifier metadata object response data system object output field system client string output field client ip address string output field ip address latitude number output field latitude location string output field location longitude number output field longitude via object output field via channel string output field channel source object output field source from object output field from rel string output field rel to object output field to public boolean output field public type string type of the resource example \[ { "json body" { "comments" \[] }, "status code" 200, "response headers" { "date" "tue, 06 feb 2024 07 14 53 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "7", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"46b9e823c59dea0a54f7b924c78c1058\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok" } ] list custom ticket statuses retrieve a list of all undeleted custom ticket statuses available in the zendesk ticket management account endpoint url /api/v2/custom statuses method get input argument name type required description active boolean optional if true, show only active custom ticket statuses if false, show only inactive custom ticket statuses if the filter is not used, show all custom ticket statuses default boolean optional if true, show only default custom ticket statuses if false, show only non default custom ticket statuses if the filter is not used, show all custom ticket statuses status categories string optional filter the list of custom ticket statuses by a comma separated list of status categories output parameter type description status code number http status code of the response reason string response reason phrase custom statuses array status value url string url endpoint for the request id number unique identifier status category string status value agent label string output field agent label raw agent label string output field raw agent label end user label string output field end user label raw end user label string output field raw end user label description string output field description raw description string output field raw description end user description string output field end user description raw end user description string output field raw end user description active boolean output field active default boolean output field default created at string output field created at updated at string output field updated at next page object output field next page previous page object output field previous page count number count value example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 07 14 53 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "7", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"46b9e823c59dea0a54f7b924c78c1058\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok", "json body" { "custom statuses" \[], "next page" null, "previous page" null, "count" 1 } } ] list recent tickets retrieve a list of the most recent tickets from zendesk ticket management endpoint url /api/v2/tickets/recent method get input argument name type required description sort by string optional parameter for list recent tickets sort order string optional one of asc, desc defaults to asc external id string optional lists tickets by external id external ids don't have to be unique for each ticket as a result, the request may return multiple tickets with the same external id output parameter type description status code number http status code of the response reason string response reason phrase tickets array output field tickets url string url endpoint for the request id number unique identifier external id object unique identifier via object output field via channel string output field channel source object output field source from object output field from to object output field to rel object output field rel created at string output field created at updated at string output field updated at type object type of the resource subject string output field subject raw subject string output field raw subject description string output field description priority string output field priority status string status value recipient object output field recipient requester id number unique identifier submitter id number unique identifier assignee id number unique identifier organization id number unique identifier example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 11 48 35 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x zendesk api warn" "{\ allowed parameters=>{\ controller=>\\"tickets\\", \ action=>\\"recent\\", \ unpermitted k ", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "25", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"a60c9170f7c556234a805ca149bfb891\\"" }, "reason" "ok", "json body" { "tickets" \[], "next page" null, "previous page" null, "count" 1 } } ] list tickets retrieve a list of all tickets from zendesk ticket management with available filtering options endpoint url /api/v2/tickets method get input argument name type required description sort by string optional parameter for list tickets sort order string optional one of asc, desc defaults to asc external id string optional lists tickets by external id external ids don't have to be unique for each ticket as a result, the request may return multiple tickets with the same external id output parameter type description status code number http status code of the response reason string response reason phrase tickets array output field tickets url string url endpoint for the request id number unique identifier external id object unique identifier via object output field via channel string output field channel source object output field source from object output field from to object output field to rel object output field rel created at string output field created at updated at string output field updated at type string type of the resource subject string output field subject raw subject string output field raw subject description string output field description priority string output field priority status string status value recipient object output field recipient requester id number unique identifier submitter id number unique identifier assignee id number unique identifier organization id object unique identifier example \[ { "status code" 200, "response headers" { "date" "fri, 09 feb 2024 04 09 50 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19948", "x frame options" "sameorigin", "zendesk ratelimit tickets index" "total=100; remaining=99; resets=10", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "10", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"d0d38536fead1328732513ea2965f565\\"" }, "reason" "ok", "json body" { "tickets" \[], "next page" null, "previous page" null, "count" 13 } } ] list tickets by organisation retrieve a list of zendesk tickets associated with a specified organization id endpoint url /api/v2/organizations/{{organization id}}/tickets method get input argument name type required description organization id number required unique identifier sort by string optional parameter for list tickets by organisation sort order string optional one of asc, desc defaults to asc external id string optional lists tickets by external id external ids don't have to be unique for each ticket as a result, the request may return multiple tickets with the same external id output parameter type description status code number http status code of the response reason string response reason phrase tickets array output field tickets url string url endpoint for the request id number unique identifier external id object unique identifier via object output field via channel string output field channel source object output field source from object output field from to object output field to rel object output field rel created at string output field created at updated at string output field updated at type object type of the resource subject string output field subject raw subject string output field raw subject description string output field description priority string output field priority status string status value recipient object output field recipient requester id number unique identifier submitter id number unique identifier assignee id number unique identifier organization id number unique identifier example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 12 00 37 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "zendesk ratelimit tickets index" "total=100; remaining=99; resets=23", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "23", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"a60c9170f7c556234a805ca149bfb891\\"" }, "reason" "ok", "json body" { "tickets" \[], "next page" null, "previous page" null, "count" 1 } } ] list tickets by user status retrieve a list of zendesk tickets filtered by a specific user's status, requiring the user's id and ticket status as parameters endpoint url /api/v2/users/{{user id}}/tickets/{{status}} method get input argument name type required description user id number required the id of user status string required users status related to ticket possible values are "ccd" lists tickets that the specified user is cc'd on, "followed" lists tickets that the specified user is following , "recent" lists tickets that the requesting agent recently viewed in the agent interface, not recently created or updated tickets (unless by the agent recently in the agent interface) and "requested" sort by string optional parameter for list tickets by user status sort order string optional one of asc, desc defaults to asc external id string optional lists tickets by external id external ids don't have to be unique for each ticket as a result, the request may return multiple tickets with the same external id output parameter type description status code number http status code of the response reason string response reason phrase tickets array output field tickets url string url endpoint for the request id number unique identifier external id object unique identifier via object output field via channel string output field channel source object output field source from object output field from to object output field to rel object output field rel created at string output field created at updated at string output field updated at type object type of the resource subject string output field subject raw subject string output field raw subject description string output field description priority string output field priority status string status value recipient object output field recipient requester id number unique identifier submitter id number unique identifier assignee id number unique identifier organization id number unique identifier example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 11 58 38 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x zendesk api warn" "{\ allowed parameters=>{\ controller=>\\"tickets\\", \ action=>\\"requested\\", \ unpermitte ", "x frame options" "sameorigin", "cache control" "max age=60, private", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "22", "strict transport security" "max age=31536000; includesubdomains" }, "reason" "ok", "json body" { "tickets" \[], "next page" null, "previous page" null, "count" 1 } } ] redact comment attachment permanently remove attachments from a ticket's comment in zendesk and replace them with 'redacted txt' requires attachment, comment, and ticket ids endpoint url /api/v2/tickets/{{ticket id}}/comments/{{comment id}}/attachments/{{attachment id}}/redact method put input argument name type required description attachment id number required the id of the attachment comment id number required the id of the comment ticket id number required the id of the ticket output parameter type description status code number http status code of the response reason string response reason phrase attachment object output field attachment url string url endpoint for the request id number unique identifier file name string name of the resource content url string url endpoint for the request mapped content url string url endpoint for the request content type string type of the resource size number output field size width number unique identifier height number output field height inline boolean output field inline deleted boolean output field deleted malware access override boolean unique identifier malware scan result string result of the operation thumbnails array output field thumbnails example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 11 13 04 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "56", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"b9e448c087f27571544d4e6da9bb90c9\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok", "json body" { "attachment" {} } } ] show ticket retrieve detailed properties of a zendesk ticket by providing the ticket id, excluding comments endpoint url /api/v2/tickets/{{ticket id}} method get input argument name type required description ticket id number required the id of the ticket output parameter type description status code number http status code of the response reason string response reason phrase attachments array output field attachments author id number unique identifier body string request body data created at string output field created at id number unique identifier metadata object response data system object output field system client string output field client ip address string output field ip address latitude number output field latitude location string output field location longitude number output field longitude via object output field via channel string output field channel source object output field source from object output field from rel string output field rel to object output field to public boolean output field public type string type of the resource example \[ { "json body" { "attachments" \[], "author id" 123123, "body" "thanks for your help!", "created at" "2009 07 20t22 55 29z", "id" 1274, "metadata" {}, "public" true, "type" "comment" }, "status code" 200, "response headers" { "date" "tue, 06 feb 2024 07 14 53 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "7", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"46b9e823c59dea0a54f7b924c78c1058\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok" } ] update attachment for malware enable or restrict agent access to zendesk attachments flagged for malware using the attachment id endpoint url /api/v2/attachments/{{attachment id}} method put input argument name type required description attachment id number required the id of the attachment attachment object optional parameter for update attachment for malware malware access override boolean optional unique identifier output parameter type description status code number http status code of the response reason string response reason phrase attachment object output field attachment url string url endpoint for the request id number unique identifier file name string name of the resource content url string url endpoint for the request mapped content url string url endpoint for the request content type string type of the resource size number output field size width object unique identifier height object output field height inline boolean output field inline deleted boolean output field deleted malware access override boolean unique identifier malware scan result string result of the operation thumbnails array output field thumbnails file name string name of the resource file string output field file example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 10 59 06 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "54", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"d0a62f4583997f86ff3390a37a50bfd8\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok", "json body" { "attachment" {} } } ] update custom ticket status updates a ticket's custom status in zendesk using the specified custom status id and custom status object endpoint url /api/v2/custom statuses/{{custom status id}} method put input argument name type required description custom status id number required the id of the custom status custom status object required status value active boolean optional if true, the custom status is set to active if false, the custom status is set to inactive agent label string optional the dynamic content placeholder or the label displayed to agents maximum length for displayed label is 48 characters description string optional the description of when the user should select this custom ticket status end user description string optional the description displayed to end users end user label string optional the dynamic content placeholder or the label displayed to end users maximum length for displayed label is 48 characters output parameter type description status code number http status code of the response reason string response reason phrase custom status object status value url string url endpoint for the request id number unique identifier status category string status value agent label string output field agent label raw agent label string output field raw agent label end user label string output field end user label raw end user label string output field raw end user label description string output field description raw description string output field raw description end user description string output field end user description raw end user description string output field raw end user description active boolean output field active default boolean output field default created at string output field created at updated at string output field updated at example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 07 28 05 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "55", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"be107b7ca2dce7f56e58454ed27479a9\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok", "json body" { "custom status" {} } } ] update many tickets in batch updates multiple zendesk tickets in a single batch operation, requiring a json body with 'tickets' details endpoint url /api/v2/tickets/update many method put input argument name type required description tickets array required parameter for update many tickets in batch id number optional unique identifier additional tags array optional parameter for update many tickets in batch output parameter type description status code number http status code of the response reason string response reason phrase job status object status value id string unique identifier job type string type of the resource url string url endpoint for the request total number output field total progress object output field progress status string status value message object response message results object result of the operation example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 06 46 32 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "28", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"57f6e8d4bf5ec67584a37d96ac0c934b\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok", "json body" { "job status" {} } } ] update many tickets in bulk updates multiple zendesk tickets with the same changes simultaneously, requiring ticket ids and the desired modifications endpoint url /api/v2/tickets/update many method put input argument name type required description ids string required unique identifier ticket object required parameter for update many tickets in bulk status string optional status value output parameter type description status code number http status code of the response reason string response reason phrase job status object status value id string unique identifier job type string type of the resource url string url endpoint for the request total number output field total progress object output field progress status string status value message object response message results object result of the operation example \[ { "status code" 200, "response headers" { "date" "tue, 06 feb 2024 06 37 25 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19904", "x frame options" "sameorigin", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "35", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"2b35e19511226ca95530c99b7e7cdd49\\"", "cache control" "max age=0, private, must revalidate" }, "reason" "ok", "json body" { "job status" {} } } ] update ticket updates a specified ticket in zendesk by ticket id, requiring details of the ticket to be provided in json format endpoint url /api/v2/tickets/{{ticket id}} method put input argument name type required description ticket id number required unique identifier ticket object required parameter for update ticket priority string optional parameter for update ticket output parameter type description status code number http status code of the response reason string response reason phrase ticket object output field ticket url string url endpoint for the request id number unique identifier external id object unique identifier via object output field via channel string output field channel source object output field source from object output field from to object output field to rel object output field rel created at string output field created at updated at string output field updated at type object type of the resource subject string output field subject raw subject string output field raw subject description string output field description priority string output field priority status string status value recipient object output field recipient requester id number unique identifier submitter id number unique identifier assignee id number unique identifier organization id number unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "json body" { "ticket" {}, "audit" {} } } ] upload files uploads a file to zendesk ticket management, allowing it to be attached to a ticket comment requires filename and form data endpoint url /api/v2/uploads method post input argument name type required description filename string required name of the resource form data object required response data files array required parameter for upload files file string required parameter for upload files file name string required name of the resource output parameter type description status code number http status code of the response reason string response reason phrase upload object output field upload token string output field token expires at string output field expires at attachments array output field attachments attachment object output field attachment url string url endpoint for the request id number unique identifier file name string name of the resource content url string url endpoint for the request mapped content url string url endpoint for the request content type string type of the resource size number output field size width object unique identifier height object output field height inline boolean output field inline deleted boolean output field deleted malware access override boolean unique identifier malware scan result string result of the operation thumbnails array output field thumbnails file name string name of the resource file string output field file example \[ { "status code" 201, "response headers" { "date" "tue, 06 feb 2024 06 08 02 gmt", "content type" "application/json; charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "x zendesk api version" "v2", "x zendesk application version" "v19901", "x frame options" "sameorigin", "zendesk ratelimit tickets update" "total=20; remaining=19; resets=58", "x rate limit" "400", "ratelimit limit" "400", "x rate limit remaining" "399", "ratelimit remaining" "399", "ratelimit reset" "58", "strict transport security" "max age=31536000; includesubdomains", "etag" "w/\\"87f2937f6f8db35dc2f9d62e25741ba4\\"" }, "reason" "ok", "json body" { "upload" {} } } ] response headers header description example cache control directives for caching mechanisms max age=60, private cf cache status http response header cf cache status dynamic cf ray http response header cf ray 85294259d9c485c5 bom connection http response header connection keep alive content encoding http response header content encoding gzip content length the length of the response body in bytes 3554 content type the media type of the resource application/json date the date and time at which the message was originated tue, 06 feb 2024 06 08 02 gmt etag an identifier for a specific version of a resource w/"a60c9170f7c556234a805ca149bfb891" location the url to redirect a page to https //swimlane8983 zendesk com/api/v2/tickets/14 json https //swimlane8983 zendesk com/api/v2/tickets/14 json nel http response header nel {"success fraction" 0 01,"report to" "cf nel","max age" 604800 } ratelimit limit http response header ratelimit limit 400 ratelimit remaining http response header ratelimit remaining 399 ratelimit reset http response header ratelimit reset 28 report to http response header report to {"endpoints" \[{"url" " https //a nel cloudflare com/report/v3?s=rbllccyqmlokpqocnrhoah8exrh2wlqbyiiatf%2fac%2bw4pr3a2gzz3yy6vxl%2fvllvbz04svwk8a4vi4ovcp3pxbvxwmndjim4ld8drwl%2bu%2fhrjjqunuawr31q63ynnpnp%2bbksoftvi5lx4w%3d%3d"}],"group" "cf nel","max age https //a nel cloudflare com/report/v3?s=rbllccyqmlokpqocnrhoah8exrh2wlqbyiiatf%2fac%2bw4pr3a2gzz3yy6vxl%2fvllvbz04svwk8a4vi4ovcp3pxbvxwmndjim4ld8drwl%2bu%2fhrjjqunuawr31q63ynnpnp%2bbksoftvi5lx4w%3d%3d"}],"group" "cf nel","max age " 604800 } server information about the software used by the origin server cloudflare set cookie http response header set cookie zendesk cookie=bahjihl7imrldmljzv90b2tlbnmiont9fqy6bkvu 0bf2100788cb010d0183feca16aaf88ccaf719ca; path=/; expires=thu, 06 feb 2025 06 09 32 gmt; secure; httponly; samesite=none, cfruid=84969939ec967d30a6d36b404c81fc54564d4f8e 1707220718; path=/; domain= swimlane8983 zendesk com; httponly; secure; samesite=none strict transport security http response header strict transport security max age=31536000; includesubdomains transfer encoding http response header transfer encoding chunked x frame options http response header x frame options sameorigin x rate limit http response header x rate limit 400 x rate limit remaining http response header x rate limit remaining 399 x request id a unique identifier for the request 8512e1b94cdc85d9 bom, 8512e1b94cdc85d9 bom x runtime http response header x runtime 0 092227 x zendesk api gateway http response header x zendesk api gateway yes notes below steps are required to access api's zendesk account creation navigate to https //{account specific subdomain} zendesk com/admin/apps integrations/apis/zendesk api/ toggle password access(by default its disabled) for accessing api's through basic authentication toggle token access and create tokens for accessing api's through custom token authentication create oauth clients to access api through bearer token which got generated by oauth mechanism client id which is required in oauth mechanism can be fetched by following below mentioned process list clients https //developer zendesk com/api reference/ticketing/oauth/oauth clients/#list clients