Freshdesk Freshdesk: Companies

Summary

This module contains actions for interacting with Freshdesk companies.

Actions

freshdesk.companies.

display

Display companies in a table.

The table will have the following columns:

  • Name
  • Description
  • Notes
  • Health Score
  • Account Tier
  • Industry
  • ID

Minimum Plugin Version: 2.0.0

Input
  • text: the title of the table

  • companies: any number of Companies

Output

Nothing is outputted by this action.

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
  - freshdesk.companies.search:
      search_params:
        name: 'Osirium'
    load:
      freshdesk: freshdesk_secrets
    save: companies_search_result

- freshdesk.companies.display:
    text: Companies
  load:
    companies: companies_search_result

freshdesk.companies.

get_all

Get all companies from Freshdesk.

Minimum Plugin Version: 1.0.0

Input
Output

A list of Companies.

Example
1
2
3
4
- freshdesk.companies.get_all:
  load:
    freshdesk: freshdesk_secrets
  save: all_companies

freshdesk.companies.

get_by_id

Get a company by it's unique ID.

Minimum Plugin Version: 1.0.0

Input
  • freshdesk: a Freshdesk dictionary

  • company_id: the id number of the company

Output

A single Company.

Example
1
2
3
4
5
- freshdesk.companies.get_by_id:
  load:
    freshdesk: freshdesk_secrets
    company_id: id
  save: individual_company

freshdesk.companies.

input_table

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

The table will have the following columns:

  • Name
  • Description
  • Notes
  • Health Score
  • Account Tier
  • Industry
  • 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

  • companies: any number ofCompanies

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

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

Output

A list of the selected Companies

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 companies from a search

  • Select the desired companies from the search output using an input table

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
  - freshdesk.companies.search:
      search_params:
        name: 'Osirium'
    load:
      freshdesk: freshdesk_secrets
    save: companies

- freshdesk.companies.input_table:
    text: Search companies
  load:
    tickets: companies
  save: selected_companies

freshdesk.companies.

output_table

Display companies in a table.

The table will have the following columns:

  • Name
  • Description
  • Notes
  • Health Score
  • Account Tier
  • Industry
  • 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

  • companies: any number of Companies

Output

Nothing is outputted by this action.

Example
  • Get a list of companies from a search action

  • Display the output in a table using output_table

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
  - freshdesk.companies.search:
      search_params:
        name: 'Osirium'
    load:
      freshdesk: freshdesk_secrets
    save: companies_search_result

- freshdesk.companies.output_table:
    text: Companies
  load:
    companies: companies_search_result

freshdesk.companies.

Search for companies using one or more attributes & values.

Supported search fields are as follows:

  • Name
  • Domain

Minimum Plugin Version: 2.0.0

Input
  • freshdesk: a Freshdesk dictionary

  • search_params: a dictionary of the search parameters

Output

A SearchResult containing:

Search Result Format

The search result format was updated in version 2.0.0 of this plugin.

It is not compatible with playbooks written against previous versions.

See here for more information.

Example
1
2
3
4
5
6
  - freshdesk.companies.search:
      search_params:
        name: 'Osirium'
    load:
      freshdesk: freshdesk_secrets
    save: companies

freshdesk.companies.

select

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

The table will have the following columns:

  • Name
  • Description
  • Notes
  • Health Score
  • Account Tier
  • Industry
  • ID

Minimum Plugin Version: 2.0.0

Input
  • text: the title of the table

  • companies: any number of Companies

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

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

Output

A Selection containing:

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
  - freshdesk.companies.search:
      search_params:
        name: 'Osirium'
    load:
      freshdesk: freshdesk_secrets
    save: companies

- freshdesk.companies.select:
    text: Search companies
  load:
    companies: companies
  save: selected_companies

freshdesk.companies.

select_one

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

The table will have the following columns:

  • Name
  • Description
  • Notes
  • Health Score
  • Account Tier
  • Industry
  • ID

Minimum Plugin Version: 2.0.0

Input
  • text: the title of the table

  • companies: any number of Companies

Output

A single Company

Example
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
  - freshdesk.companies.search:
      search_params:
        name: 'Osirium'
    load:
      freshdesk: freshdesk_secrets
    save: companies

- freshdesk.companies.select_one:
    text: Search companies
  load:
    companies: companies
  save: selected_company