Freshdesk: Agents

Summary

This module contains actions for interacting with Freshdesk agents.

Actions

freshdesk.agents.

display

Display agents in a table.

The table will have the following columns:

• Name
• Email
• Job Title
• Available
• Ticket Permissions
• ID

Minimum Plugin Version: 2.0.0

Input

• text: the title of the table

• agents: any number of Agents

Output

Nothing is outputted by this action.

Example

- freshdesk.agents.get_all:
  load:
    freshdesk: freshdesk_secrets
  save: all_agents

- freshdesk.agents.display:
    text: All the agents
  load:
    agents: all_agents

freshdesk.agents.

get_all

Get all agents from Freshdesk.

Minimum Plugin Version: 1.0.0

Input

• freshdesk: a Freshdesk dictionary

Output

A list of Agents

Example

- freshdesk.agents.get_all:
  load:
    freshdesk: freshdesk_secrets
  save: all_agents

freshdesk.agents.

get_by_id

Get an agent by their unique ID.

Minimum Plugin Version: 1.0.0

Input

• freshdesk: a Freshdesk dictionary

• agent_id: the id number of the agent

Output

A single Agent.

Example

- freshdesk.agents.get_by_id:
  load:
    freshdesk: freshdesk_secrets
    ticket_id: id
  save: individual_agent

freshdesk.agents.

input_table

Display agents in a table, & allow the task operator to make a selection.

The table will have the following columns:

• Name
• Email
• Job Title
• Available
• Ticket Permissions
• ID

Deprecation Warning

This action will soon be deprecated in favour of select.

Minimum Plugin Version: 1.0.0

Input

• text: the title of the table

• agents: any number ofAgents

• minimum: the minimum number of acceptable selections (Optional)

• maximum: the maximum number of acceptable selections (Optional)

Output

A list of the selected Agents

Tip

• If neither a minimum or maximum is provided, the task operator will be able to submit 0 selections.
• If minimum or maximum are provided, the operation will repeat until the task operator makes a valid number of selections.

Example

• Get a list of all the agents

• Select the desired agents from the total list using an input table

- freshdesk.agents.get_all:
  load:
    freshdesk: freshdesk_secrets
  save: all_agents

- freshdesk.agents.input_table:
    text: Select Agents
  load:
    tickets: all_agents
  save: selected_agents

freshdesk.agents.

output_table

Display agents in a table.

The table will have the following columns:

• Name
• Email
• Job Title
• Available
• Ticket Permissions
• ID

Deprecation Warning

This action will soon be deprecated in favour of display.

Minimum Plugin Version: 1.0.0

Input

• text: the title of the table

• agents: any number ofAgents

Output

Nothing is outputted by this action.

Example

• Get a list of all the agents

• Display the output in a table using output_table

- freshdesk.agents.get_all:
  load:
    freshdesk: freshdesk_secrets
  save: all_agents

- freshdesk.agents.output_table:
    text: All the agents
  load:
    tickets: all_agents

freshdesk.agents.

select

Display agents in a table, & allow the task operator to make a selection.

The table will have the following columns:

• Name
• Email
• Job Title
• Available
• Ticket Permissions
• ID

Minimum Plugin Version: 2.0.0

Input

• text: the title of the table

• agents: any number of Agents

• minimum: the minimum number of acceptable selections (Optional)

• maximum: the maximum number of acceptable selections (Optional)

Output

A Selection containing:

• total: the number of selected Agents

• all: a list of selected Agents

• first: the first selected Agent

Example

- freshdesk.agents.get_all:
  load:
    freshdesk: freshdesk_secrets
  save: all_agents

- freshdesk.agents.select:
    text: Select Agents
  load:
    agents: all_agents
  save: selected_agents

freshdesk.agents.

select_one

Display agents in a table & prompt the task operator to select one.

The table will have the following columns:

• Name
• Email
• Job Title
• Available
• Ticket Permissions
• ID

Minimum Plugin Version: 2.0.0

Input

• text: the title of the table

• agents: any number of Agents

Output

A single Agent

Example

- freshdesk.agents.get_all:
  load:
    freshdesk: freshdesk_secrets
  save: all_agents

- freshdesk.agents.select_one:
    text: Select an Agent
  load:
    agents: all_agents
  save: selected_agent