Skip to main content

Tickets: List Comments Tool

Usage​

All Portia tools using API endpoints that require OAuth are built with plug and play authentication support. They use Portia client credentials including client ID, client name and redirect URL. Such tools will raise a Action Clarification with an OAuth link as the action URL. The portia.wait_for_ready() method must be used in this scenario: Portia's OAuth server will listen for the authentication result and resolve the concerned clarification, allowing your plan run to resume again.

For more on this, please visit to the section on running Portia tools (↗).

Configure your Zendesk tools with Portia AI​

You will need to provide the subdomain of your Zendesk account to use with Portia AI. This is because Zendesk creates a unique subdomain for each account.

Configure access in Portia AI​

  1. Log into your Portia dashboard ↗
  2. Navigate to the Manage Org tab.
  3. Enter the subdomain of your Zendesk account. Your subdomain is the part of your Zendesk URL before the .zendesk.com domain. For example, if your Zendesk URL is https://portialabs.zendesk.com, your subdomain is portialabs.

You are now ready to call Zendesk tools on our cloud!

Tool details​

Tool ID: portia:zendesk:tickets:list_comments

Tool description: Returns the comments added to the ticket. Each comment may include a content_url for an attachment or a recording_url for a voice comment that points to a file that may be hosted externally. A ticket in Zendesk is intended to be used by agents or admins. They can be used to track and resolve requests raised by end users (e.g. customer service) or for internal issue tracking.

Args schema:

{
  "description": "Input schema for ZendeskListTicketCommentsTool.",
  "properties": {
    "ticket_id": {
      "description": "The ID of the ticket",
      "title": "Ticket Id",
      "type": "integer"
    }
  },
  "required": [
    "ticket_id"
  ],
  "title": "ZendeskListTicketCommentsToolSchema",
  "type": "object"
}

Output schema:

('application/json', 'application/json: Payload from API containing a list of comments on a Zendesk ticket.')