Skip to main content

Freshservice Authorization

Prerequisites​

Before configuring your Freshservice credential, ensure you have:

  • A Freshservice account with admin or developer permissions
  • Access to the Freshservice portal for API configuration
  • Understanding of your Freshservice portal URL and API access requirements

For complete information about Freshservice API authentication, see the official Freshservice API documentation.

Authentication Methods​

Freshservice Authentication Methods

Authenticate using your Freshservice username and password or API key for secure access to Freshservice's IT service management platform.

  1. Sign in to your Freshservice portal.
  2. Navigate to **Admin** > **API Settings** in the left sidebar.
  3. Enable **API Access** if it's not already enabled.
  4. Choose one of the following authentication methods:
  5. **Option A: Username and Password**
  6. - Use your Freshservice username and password
  7. - Enter your username in the **Username Or API Key** field
  8. - Enter your password in the **Password** field
  9. **Option B: API Key Authentication**
  10. - Generate a personal API key from **Admin** > **API Settings**
  11. - Enter your API key in the **Username Or API Key** field
  12. - Enter any dummy string (e.g., 'X') in the **Password** field
  13. Enter your **Freshservice Portal URL** in Nexla (e.g., https://yourcompany.freshservice.com).
Important

Keep your API credentials secure and never share them publicly. Your Freshservice credentials provide access to your IT service management data and should be treated as sensitive information.

Configuration Steps​

  1. Freshservice Portal URL: Enter your Freshservice portal URL (e.g., https://yourcompany.freshservice.com). This is the URL you use to access your Freshservice account.

  2. Username Or API Key: Enter either:

    • Your Freshservice username (if using username/password authentication)
    • Your personal API key (if using API key authentication)

  3. Password: Enter either:

    • Your Freshservice password (if using username/password authentication)
    • Any dummy string like 'X' (if using API key authentication)

For enhanced security, we recommend using API key authentication instead of username/password. You can generate a personal API key from Admin > API Settings in your Freshservice portal.

Testing Your Credential​

After entering your credentials, Nexla will test the connection by making a request to the Freshservice API departments endpoint. If the test is successful, your credential is ready to use for creating data sources and destinations.

For troubleshooting connection issues, verify that:

  • Your Freshservice portal URL is correct and accessible
  • API access is enabled in your Freshservice account
  • Your username/API key and password are correct
  • Your account has the necessary permissions for API access