tickets: appmixer.zendesk.tickets.MakeApiCall

Basic Information

Name

appmixer.zendesk.tickets.MakeApiCall

Version

1.0.0

Visibility

Public

Description

Generic method for making API calls to a 3rd party service.

Input Ports

in

Field	Type	Description
API Endpoint URL	text	Enter the API endpoint path relative to `https://{subdomain}.zendesk.com/api/v2` or provide a full URL.
HTTP Method	select	Select the HTTP method for the API call.
Request Body	textarea	Enter the request body as a JSON object (supports nested objects, arrays, and non-string values).
Request Headers	key-value	Optional additional request headers.
Query Parameters	key-value	Optional query parameters.

Output Ports

out

Field	Type	Description
Status Code		-
Response Headers		-
Response Body		-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.zendesk.tickets.MakeApiCall", "author": "Appmixer <info@appmixer.com>", "description": "Generic method for making API calls to a 3rd party service.", "auth": { "service": "appmixer:zendesk:tickets", "scope": [ "read", "tickets:write", "users:write", "organizations:write" ] }, "inPorts": [ { "name": "in", "inspector": { "inputs": { "url": { "type": "text", "index": 1, "label": "API Endpoint URL", "tooltip": "Enter the API endpoint path relative to <code>https://{subdomain}.zendesk.com/api/v2</code> or provide a full URL." }, "method": { "type": "select", "index": 2, "label": "HTTP Method", "defaultValue": "GET", "tooltip": "Select the HTTP method for the API call.", "options": [ { "label": "GET", "value": "GET" }, { "label": "POST", "value": "POST" }, { "label": "PUT", "value": "PUT" }, { "label": "PATCH", "value": "PATCH" }, { "label": "DELETE", "value": "DELETE" } ] }, "body": { "type": "textarea", "index": 4, "label": "Request Body", "tooltip": "Enter the request body as a JSON object (supports nested objects, arrays, and non-string values)." }, "headers": { "type": "key-value", "keyLabel": "Key", "valueLabel": "Value", "addLabel": "Add item", "removeLabel": "Remove item", "label": "Request Headers", "index": 5, "tooltip": "Optional additional request headers." }, "parameters": { "type": "key-value", "keyLabel": "Key", "valueLabel": "Value", "addLabel": "Add item", "removeLabel": "Remove item", "label": "Query Parameters", "index": 3, "tooltip": "Optional query parameters." } } }, "schema": { "type": "object", "properties": { "url": { "type": "string" }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ], "default": "GET" }, "body": { "type": "string" }, "headers": { "type": "string" }, "parameters": { "type": "string" } }, "required": [ "url", "method" ] } } ], "outPorts": [ { "name": "out", "options": [ { "label": "Status Code", "value": "status" }, { "label": "Response Headers", "value": "headers", "schema": { "example": "{}" } }, { "label": "Response Body", "value": "body", "schema": { "type": "object", "properties": {}, "example": "{}" } } ] } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48IS0tIFVwbG9hZGVkIHRvOiBTVkcgUmVwbywgd3d3LnN2Z3JlcG8uY29tLCBHZW5lcmF0b3I6IFNWRyBSZXBvIE1peGVyIFRvb2xzIC0tPgo8c3ZnIGZpbGw9IiMwMDAwMDAiIHdpZHRoPSI4MDBweCIgaGVpZ2h0PSI4MDBweCIgdmlld0JveD0iMCAwIDE0IDE0IiByb2xlPSJpbWciIGZvY3VzYWJsZT0iZmFsc2UiIGFyaWEtaGlkZGVuPSJ0cnVlIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPjxwYXRoIGQ9Im0gNi41NDI1LDExLjU0NzUgLTUuNTQyNSwwIDUuNTQyNSwtNi42OTE1IDAsNi42OTE1IHogbSA2LjQ1NzUsMCAtNS41NDI1LDAgYyAwLC0xLjUzMTUgMS4yMzk1LC0yLjc3MTUgMi43NzE1LC0yLjc3MTUgMS41MzE1LDAgMi43NzEsMS4yNDEgMi43NzEsMi43NzE1IHogbSAtNS41NDI1LC0yLjQwMiAwLC02LjY5MyA1LjU0MjUsMCAtNS41NDI1LDYuNjkzIHogTSA2LjU0MjUsMi40NTI1IEMgNi41NDI1LDMuOTgzIDUuMzAyLDUuMjI0NSAzLjc3MSw1LjIyNDUgMi4yNDEsNS4yMjQ1IDEsMy45ODQgMSwyLjQ1MzUgbCA1LjU0MjUsMCAwLC0xMGUtNCB6Ii8+PC9zdmc+" }