Zendesk Actions

Zendesk Actions allow you to interact with tickets and other resources through the Zendesk API.

All Zendesk actions must use the Zendesk connection instance created by the connect action.

Actions

zendesk.connect

Establish a connection with Zendesk API using provided credentials.

Parameters:

email (optional) - Email of the Zendesk account.
password (optional) - Password of the Zendesk account.
subdomain (optional) - Subdomain of the Zendesk instance.
token (optional) - API token for authentication.
oauth_token (optional) - OAuth token for authentication.

Returns:

zendesk - Zendesk API connection instance.

Exceptions:

This action returns no Exception.

zendesk.search

Search for tickets in Zendesk based on provided criteria.

Parameters:

zendesk - Zendesk connection instance returned by zendesk.connect.
kwargs - Search filters and criteria to pass to Zendesk search.

Returns:

tickets - List of tickets matching the search criteria, each represented as a dictionary.

Exceptions:

This action returns no Exception.

zendesk.add_tags

Add tags to a specific Zendesk ticket.

Parameters:

zendesk - Zendesk connection instance returned by zendesk.connect.
ticket_id - ID of the ticket to update.
tags - List of tags or a single string tag to be added.

Returns:

This action has no return.

Exceptions:

ValueError - if tags parameter is not a string or a list.

zendesk.change_status

Change the status of a specific Zendesk ticket.

Parameters:

zendesk - Zendesk connection instance returned by zendesk.connect.
ticket_id - ID of the ticket to update.
new_status - Status to assign to the ticket (e.g., "solved", "open").

Returns:

This action has no return.

Exceptions:

This action returns no Exception.