Skip to main content

Freshservice

Visualize Freshservice information, map Freshservice agents to employees, and monitor changes through queries and alerts.

Installation​

To set up the Freshservice integration you will need the API key of a Freshservice admin-level agent. The API key carries the privileges of the agent that generated it, and Freshservice treats agent, role, and group reads as admin APIs. A non-admin key returns a restricted or empty data set, and ticket visibility is scoped to the agent's role and groups, so a complete ingestion requires an admin-level key.

Prerequisites​

  • A Freshservice agent with admin-level privileges.
  • The agent's API key. To find it, log in to your Freshservice support portal, click your profile picture in the top-right corner, and go to the Profile settings page. Your API key is shown below the Delegate Approvals section. See Where do I find my API key? for more information.
note

To review or adjust an agent's privileges, go to Admin > Roles, create or edit a role, and associate it with the agent under Admin > Agents > edit agent > Permission tab. See Setting up roles and role-based access controls.

Configuration in JupiterOne​

To install the Freshservice integration in JupiterOne, navigate to the Integrations tab in JupiterOne and select Freshservice. Click New Instance to begin configuring your integration.

Creating an instance requires the following:

  • The Host Name of your Freshservice account — the subdomain portion of your Freshservice URL (for example, example from example.freshservice.com).

  • Your Freshservice API Key, generated from the Profile settings page as described above.

  • A Description to assist in identifying the integration instance, if desired.

  • A Polling Interval that you feel is sufficient for your monitoring needs. You may leave this as DISABLED and manually execute the integration.

Data Volume Configuration​

Control how much ticket data is ingested from Freshservice.

Ingestion Windows​

FieldDescriptionDefaultOptions
Ticket Lookback WindowHow far back, in days, to ingest tickets. The Freshservice API only returns tickets created within the past 30 days by default; this setting looks back further by filtering on each ticket's last-updated time, so it also includes any ticket updated within the window.9090, 180, 365

Longer windows increase the number of tickets ingested.

Click Create once all values are provided to finalize the integration.

Next steps​

Now that your integration instance has been configured, it will begin running on the polling interval you provided, populating data within JupiterOne. Continue on to our Instance management guide to learn more about working with and editing integration instances.