Freshservice - Tracecat Docs

Call endpoint

Action ID: tools.freshservice.call_endpoint Call a Freshservice REST API endpoint with API-key Basic auth. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

FreshserviceMethod

required

HTTP method for the Freshservice API request.

string

required

Freshservice API path, e.g. /tickets.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

map[string, string] | null

Additional HTTP headers to send.Default: null.

object | null

Freshservice JSON request body.Default: null.

object | null

Freshservice query parameters.Default: null.

number

Request timeout in seconds.Default: 30.0.

Call paginated endpoint

Action ID: tools.freshservice.call_paginated_endpoint Call a Freshservice list endpoint and follow page/per_page pagination. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

string

required

Freshservice list API path, e.g. /tickets.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

string | null

Response field containing the page items, e.g. tickets. If omitted, Tracecat infers the only list-valued response field.Default: null.

integer | null

Maximum pages to fetch.Default: null.

integer

Freshservice page number to start from.Default: 1.

integer

Freshservice per_page value.Default: 30.

object | null

Freshservice query parameters.Default: null.

number

Request timeout in seconds.Default: 30.0.

Create change

Action ID: tools.freshservice.create_change Create a Freshservice change. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice change payload.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Create requester

Action ID: tools.freshservice.create_requester Create a Freshservice requester. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice requester payload.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Create ticket

Action ID: tools.freshservice.create_ticket Create a Freshservice ticket. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice ticket payload, e.g. subject, description, email/requester_id, priority, and status.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Create ticket note

Action ID: tools.freshservice.create_ticket_note Add a note to a Freshservice ticket. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice note payload.

integer

required

Freshservice ticket ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Delete ticket

Action ID: tools.freshservice.delete_ticket Delete a Freshservice ticket. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

integer

required

Freshservice ticket ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Get agent

Action ID: tools.freshservice.get_agent Get a Freshservice agent by ID. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

integer

required

Freshservice agent ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Get change

Action ID: tools.freshservice.get_change Get a Freshservice change by ID. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

integer

required

Freshservice change ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Get group

Action ID: tools.freshservice.get_group Get a Freshservice group by ID. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

integer

required

Freshservice group ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Get requester

Action ID: tools.freshservice.get_requester Get a Freshservice requester by ID. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

integer

required

Freshservice requester ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Get ticket

Action ID: tools.freshservice.get_ticket Get a Freshservice ticket by ID. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

integer

required

Freshservice ticket ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

string | null

Optional Freshservice include parameter.Default: null.

List agents

Action ID: tools.freshservice.list_agents List Freshservice agents with optional filters. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

integer | null

Maximum pages to fetch.Default: null.

integer

Freshservice page number to start from.Default: 1.

integer

Freshservice per_page value.Default: 30.

object | null

Freshservice query parameters.Default: null.

List changes

Action ID: tools.freshservice.list_changes List Freshservice changes with optional filters. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

integer | null

Maximum pages to fetch.Default: null.

integer

Freshservice page number to start from.Default: 1.

integer

Freshservice per_page value.Default: 30.

object | null

Freshservice query parameters.Default: null.

List groups

Action ID: tools.freshservice.list_groups List Freshservice groups with optional filters. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

integer | null

Maximum pages to fetch.Default: null.

integer

Freshservice page number to start from.Default: 1.

integer

Freshservice per_page value.Default: 30.

object | null

Freshservice query parameters.Default: null.

List requesters

Action ID: tools.freshservice.list_requesters List Freshservice requesters with optional filters. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

integer | null

Maximum pages to fetch.Default: null.

integer

Freshservice page number to start from.Default: 1.

integer

Freshservice per_page value.Default: 30.

object | null

Freshservice query parameters.Default: null.

List tickets

Action ID: tools.freshservice.list_tickets List Freshservice tickets with optional filters. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

integer | null

Maximum pages to fetch.Default: null.

integer

Freshservice page number to start from.Default: 1.

integer

Freshservice per_page value.Default: 30.

object | null

Freshservice query parameters.Default: null.

Reply to ticket

Action ID: tools.freshservice.reply_to_ticket Add a reply to a Freshservice ticket. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice ticket reply payload.

integer

required

Freshservice ticket ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Update change

Action ID: tools.freshservice.update_change Update a Freshservice change. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice change fields to update.

integer

required

Freshservice change ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Update requester

Action ID: tools.freshservice.update_requester Update a Freshservice requester. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice requester fields to update.

integer

required

Freshservice requester ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.

Update ticket

Action ID: tools.freshservice.update_ticket Update a Freshservice ticket. Reference: https://api.freshservice.com/

Secrets

Required secrets:

freshservice: required values FRESHSERVICE_API_KEY; optional values FRESHSERVICE_BASE_URL.

Input fields

object

required

Freshservice ticket fields to update.

integer

required

Freshservice ticket ID.

string | null

Freshservice tenant URL or API URL. Defaults to FRESHSERVICE_BASE_URL, e.g. https://example.freshservice.com.Default: null.