Custom API Action

Make a custom, authenticated HTTP call to the Zendesk API.

Options

Field Definition Type Required
Request Type

One of five supported HTTP request methods (sometimes called verbs) in custom API calls:

  • GET retrieves data from a web server based on your parameters. GET requests a representation of the specified resource. If successful, GET will receive a 200 OK response message with the requested content. Refer to additional documentation here.

  • POST sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POSTs may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POSTs. If a POST is successful, you will receive a 200 OK response message. Refer to additional documentation here.

  • PUT sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT requestss. If a PUT is successful, you will receive a 200 response message (usually 201 or 204). Refer to additional documentation here.

  • PATCH applies partial modifications to a resource on a web server based on your parameters. PATCH is not idempotent, meaning that multiple PATCH requests could have unintended consequences. If a PUT is successful, you will receive a 200 response message (usually 204). Refer to additional documentation here.

  • DELETE deletes the specified resource from the web server based on your parameters (if the resource exists). If a DELETE is successful, you will receive a 200 OK response message. Refer to additional documentation here.

Dropdown TRUE

Input

Field Definition Type Required
Relative URL Specify the relative URL as /api/v2/{insert_remaining_URL}. You can specify query parameters in the relative URL using “?”, or specify the query parameters as an object key pair in the Query input. Example: https://{{auth.subdomain}}.zendesk.com{{input.Request.Relative URL}} String FALSE
Query Specify any additional query parameters that should be included in object format (key value pairs). Object FALSE
Headers Specify any headers required in addition to authorization or content-type (these are already handled by this connector). Object FALSE
Body Specify a request body in JSON format. Only available for POST, PUT, and PATCH requests. Object FALSE

Output

Field Definition Type
Status Code Result of your HTTP request. See HTTP status codes. Number
Headers Detailed context for the status code, unrelated to the output body. Response headers are dependent on your selected HTTP request option. Note that not all headers are response headers. This will be usually similar to {"Content-type":"application/json"}. Object
Body Data returned from your selected HTTP request (for example, the data from a GET request). Object

Related topics

Zendesk connector

About the elements of Okta Workflows

Zendesk REST API Documentation