Skip to content

Commit

Permalink
docs(connect-ui): freshservice connect ui docs (NangoHQ#3254)
Browse files Browse the repository at this point in the history
## Describe the problem and your solution
Added Freshservice `connect-ui` docs

<!-- Issue ticket number and link (if applicable) -->

<!-- Testing instructions (skip if just adding/editing providers) -->

Co-authored-by: Hassan Wari <[email protected]>
  • Loading branch information
hassan254-prog and Hassan Wari authored Jan 7, 2025
1 parent b74b79f commit 7bd4918
Show file tree
Hide file tree
Showing 8 changed files with 51 additions and 6 deletions.
5 changes: 5 additions & 0 deletions docs-v2/integrations/all/freshservice.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,8 @@ _No setup guide yet._
## API gotchas

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/freshservice.mdx)</Note>

## Going further
<Card title="Connect to Freshservice" icon="link" href="/integrations/all/freshservice/connect" horizontal>
Guide to connect to Freshservice using Nango Connect UI.
</Card>
Binary file added docs-v2/integrations/all/freshservice/api_key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 37 additions & 0 deletions docs-v2/integrations/all/freshservice/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Freshservice - How do I link my account?
sidebarTitle: Freshservice
---


# Overview

To authenticate with Freshservice, you need:
1. **API Key** - Your Freshservice API Key.
2. **Freshservice subdomain** - Your unique Freshservice subdomain (e.g., mycompany.freshservice.com).

This guide will walk you through finding both your **API Key** and **Freshservice subdomain** within Freshservice.

### Prerequisites:

- You must have a Freshservice account with admin privileges.

#### Step 1: Finding Your Freshservice API Key
1. Login to your **Freshservice** account. Click on your **Profile picture** and select **Personal Settings**.
<img src="/integrations/all/freshservice/profile.png" />
2. Your **API Key** will then be available below the **Delegate Approvals** section to your right.
<img src="/integrations/all/freshservice/api_key.png" />

#### Step 2: Finding Your Freshservice subdomain
1. Login to your **Freshservice** account. On you address bar, The URL will be similar to: `https://mycompany.freshservice.com`. Your subdomain is the text between `https://` and `.freshservice.com`, which in this case would be `mycompany`.

#### Step 3: Enter credentials in the Connect UI

Once you have your **API Key** and **Freshservice Domain**:
1. Open the form where you need to authenticate with Freshservice.
2. Enter the **API Key** and **Freshservice subdomain** in their designated fields.
3. Submit the form, and you should be successfully authenticated.

<img src="/integrations/all/freshservice/form.png" style={{maxWidth: "450px" }}/>

You are now connected to Freshservice.
Binary file added docs-v2/integrations/all/freshservice/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs-v2/integrations/all/freshservice/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs-v2/integrations/all/sap-success-factors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ provider: sap-success-factors
import Overview from "/snippets/overview.mdx";

import PreBuiltUseCases from "/snippets/generated/sap-success-factors/PreBuiltUseCases.mdx"
import PreBuiltUseCases from "/snippets/generated/sap-success-factors/PreBuiltTooling.mdx"
import PreBuiltTooling from "/snippets/generated/sap-success-factors/PreBuiltTooling.mdx"

<Overview />
<PreBuiltTooling />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
| Pre-built authorization (Basic) ||
| Pre-built authorization UI ||
| Custom authorization UI ||
| End-user authorization guide | 🚫 |
| End-user authorization guide | |
| Expired credentials detection ||
</Accordion>
<Accordion title="✅ Read & write data">
Expand Down
11 changes: 7 additions & 4 deletions packages/shared/providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2881,7 +2881,7 @@ freshsales:
doc_section: '#step-1-finding-your-freshsales-api-key'

freshservice:
display_name: FreshService
display_name: Freshservice
categories:
- support
auth_mode: BASIC
Expand All @@ -2893,21 +2893,24 @@ freshservice:
retry:
after: 'retry-after'
docs: https://docs.nango.dev/integrations/all/freshservice
docs_connect: https://docs.nango.dev/integrations/all/freshservice/connect
connection_config:
subdomain:
type: string
title: FreshService Domain
description: The subdomain of your FreshService account
title: Freshservice subdomain
description: The subdomain of your Freshservice account
pattern: '^[a-z0-9_-]+$'
example: domain
example: subdomain
suffix: .freshservice.com
prefix: https://
doc_section: '#step-2-finding-your-freshservice-subdomain'
credentials:
username:
type: string
title: API key
description: The API Key of your Freshservice account
secret: true
doc_section: '#step-1-finding-your-freshservice-api-key'
password:
type: string
title: ''
Expand Down

0 comments on commit 7bd4918

Please sign in to comment.