zendesk

Zendesk service desk platform.

Actions

Zendesk Connect

Connect to a Zendesk instance via API.

Input

Name	Description	Type	Required	Syntax
Zendesk Domain	Domain of your Zendesk domain.	input	True	True
Agent Email	Email address of the agent to authenticate as.	input	False	True
Use Token Authentication	When checked a token can be provided instead of password based authentication when connecting to Zendesk.	group-checkbox	False	False
Password	Password used to authenticate to Zendesk.	password-input	False	True
API Token	API token used to authenticate to Zendesk.	password-input	False	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Zendesk connection handler created."}}
rc	Returns the exit code for the action.	number	True	{"200": {"description": "Zendesk connection handler created."}}
zendesk_connection_id	The internal A-Ops index reference for the given connection.	number	True	{}

---

Zendesk Custom Request

Execute a custom API call against a given endpoint.

Input

Name	Description	Type	Required	Syntax
Connection ID	The existing Zendesk connection ID generated when calling Zendesk Connect.	input	True	True
URI	API endpoint URI	input	True	True
HTTP Method	The HTTP method to use e.g. HEAD, GET, PUT, POST, DELETE.	dropdown	True	True
Data	Body data to include with the request.	json-input	False	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}, "255": {"description": "No connection handler found or it could not be loaded."}}
response	HTTP response json.	json	False	{}
status_code	HTTP response status code.	number	False	{}

---

Zendesk Update Ticket

Update a ticket by ID and corresponding fields.

Input

Name	Description	Type	Required	Syntax
Connection ID	The existing Zendesk connection ID generated when calling Zendesk Connect.	input	True	True
Ticket ID	ID of the ticket to update.	input	True	True
Ticket Data	JSON key/value key pairs that represent fields to update within the ticket.	json-input	True	True
Return Ticket Values	When checked and updates are successful the entire response is provided.	checkbox	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}, "255": {"description": "No connection handler found or it could not be loaded."}}
msg	Additional information i.e. full ticket details when return ticket values is checked.	json	True	{}

---

Zendesk Oauth List Clients

Returns a list of configured zendesk Oauth clients.

Input

Name	Description	Type	Required	Syntax
Connection ID	The existing Zendesk connection ID generated when calling Zendesk Connect.	input	True	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}
response	Data returned by the zendesk API.	json	True	{}

---

Zendesk Oauth List Tokens

Returns a list of Oauth tokens for a given Oauth client

Input

Name	Description	Type	Required	Syntax
Connection ID	The existing Zendesk connection ID generated when calling Zendesk Connect.	input	True	True
Client ID	Oauth client to list the tokens for.	input	True	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}
response	Data returned by the zendesk API.	json	True	{}

---

Zendesk Oauth Create Token

Create a new Oauth access token for a given Oauth client.

Input

Name	Description	Type	Required	Syntax
Connection ID	The existing Zendesk connection ID generated when calling Zendesk Connect.	input	True	True
Client ID	Oauth client to create the token for.	input	True	False
Scopes	List of access scopes to apply to the token that is created.	json-input	True	True

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}
response	Data returned by the zendesk API.	json	True	{}

---

Zendesk Oauth Revoke Token

Revoke an existing Oauth token

Input

Name	Description	Type	Required	Syntax
Connection ID	The existing Zendesk connection ID generated when calling Zendesk Connect.	input	True	True
Token ID	Oauth token to revoke.	input	False	False

Output

Name	Description	Type	always_present	values
result	Returns True when successful.	boolean	True	{"True": {"description": "Successful."}, "False": {"description": "Failure."}}
rc	Returns the exit code for the action.	number	True	{"0": {"description": "Successful."}}
response	Data returned by the zendesk API.	json	True	{}

---