Connecting Freshservice

Last updated: October 7, 2024

Background

This article walks through the steps to connecting the Freshservice integration to Lumos and helps you resolve common issues that might arise during the setup.

Required plan & roles

There is no minimum plan needed to connect the Freshservice integration.

Your user should be an Account Admin and have access to the admin console.

Instructions

In Freshservice

First confirm that you're an Account Admin

1. Log into Freshservice.

2. Go to Settings.

3. Scroll to User Management and click Roles.

4. Under Admin roles, ensure that you are listed as an agent for the Account Admin role.

Finding your domain name

  1. Log into Freshservice

  2. In the URL, copy the domain name that comes before freshservice.com. For example, if the URL is https://companyname.freshservice.com, the domain name is companyname.

Find your API Key

  1. Go to the Admin Panel.

  2. Click on your avatar in the top right corner.

  3. Click Profile Settings.

  4. The API Key is on the right hand side panel. You may have to do an additional confirmation before you can copy it.

In Lumos

1. Click on the Freshservice card in your Lumos integrations (Reconnect or add new).

2. Enter the domain name from the section above in the Domain Name field, then paste your API key in the API Key field.

3. Click Connect Freshservice.

Scopes

The Freshservice integration uses the following scopes.

Scope

Required

Description

default

Provides access to all endpoints documented in the Freshservice API.

Troubleshooting

Your account doesn't have the required permissions to access integrate with Freshservice.

Problem: Your Freshservice integration credentials are invalid.

Solution: Reconnect the Freshservice integration in Lumos.