Skip to content

Commit

Permalink
Merge branch 'master' into alan/pg-app-name
Browse files Browse the repository at this point in the history
  • Loading branch information
nalanj authored Jan 6, 2025
2 parents 47422f2 + 30e3d55 commit 5fc5d05
Show file tree
Hide file tree
Showing 153 changed files with 2,651 additions and 1,376 deletions.
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
20.12.2
20.18.1
7 changes: 5 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ RUN jq '. | del(.references[] | select(.path == "packages/cli"))' tsconfig.build
# ------------------
# New tmp image
# ------------------
FROM node:20.12.2-bullseye-slim AS build
FROM node:20.18.1-bookworm-slim AS build


# Setup the app WORKDIR
WORKDIR /app/tmp
Expand Down Expand Up @@ -80,8 +81,10 @@ RUN true \

# ---- Web ----
# Resulting new, minimal image
FROM node:20.12.2-bullseye-slim as web
FROM node:20.18.1-bookworm-slim as web

# Install a more recent npm
RUN npm install -g [email protected]

# - Bash is just to be able to log inside the image and have a decent shell
RUN true \
Expand Down
46 changes: 46 additions & 0 deletions docs-v2/integrations/all/builtwith.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: BuiltWith
sidebarTitle: BuiltWith
provider: builtwith
---

import Overview from '/snippets/overview.mdx';
import PreBuiltTooling from '/snippets/generated/builtwith/PreBuiltTooling.mdx';

import PreBuiltUseCases from '/snippets/generated/builtwith/PreBuiltUseCases.mdx';

<Overview />
<PreBuiltTooling />
<PreBuiltUseCases />

## Access requirements
| Pre-Requisites | Status | Comment |
| ----------------- | ------ | ------- |
| Paid dev account || |
| Paid test account || |
| Partnership || |
| App review || |
| Security audit || |

## Setup guide

_No setup guide yet._

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

<Note>
Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/builtwith.mdx)
</Note>

## Useful links

- [Generate a BuiltWith API key in your BuiltWith account](https://api.builtwith.com)
- [BuiltWith API Docs](https://api.builtwith.com/free-api)

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

## API gotchas

_No API gotchas yet._

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/builtwith.mdx)</Note>
35 changes: 35 additions & 0 deletions docs-v2/integrations/all/builtwith/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
title: BuiltWith - How do I link my account?
sidebarTitle: BuiltWith
---

# Overview

To authenticate with BuiltWith, you will need:

1. **API Key** - A key that is used to identify your BuiltWith account.

This guide will walk you through finding these Keys within BuiltWith.

### Prerequisites:

- You must have a registered BuiltWith account.

### Instructions:

#### Step 1: Finding Your API Key

1. **Log in** to your BuiltWith dashboard.
2. Open the **Tools** menu and click **API Access**.
3. You will see your API key in the **API Key** field.
4. You can also find your API key at [BuiltWith API](https://api.builtwith.com/)

#### Step 2: Enter API Key in the Connect UI

Once you have your **API Key**:

1. Open the form where you need to authenticate with BuiltWith.
2. Enter your **API Key** in the designated field.
3. Submit the form, and you should be successfully authenticated.

You are now connected to BuiltWith.
8 changes: 7 additions & 1 deletion docs-v2/integrations/all/chorus.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,10 @@ _No setup guide yet._
- Chorus uses `API_KEY` auth mode with `Authorization: Bearer ${apiKey}` in the request header to access different endpoints.
- API tokens can be generated for each Chorus user, and is managed via the Personal Settings page within the Chorus application.

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

## Going further

<Card title="Connect to Chorus" icon="link" href="/integrations/all/chorus/connect" horizontal>
Guide to connect to Chorus using Connect UI
</Card>
38 changes: 38 additions & 0 deletions docs-v2/integrations/all/chorus/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Chorus - How do I link my account?
sidebarTitle: Chorus
---


# Overview

To authenticate with Chorus, you need:
1. **API Key** - Your Chorus API Key


This guide will walk you through generating the API Key within Chorus.


### Prerequisites:

- You must have a **Chorus Admin account**. Only Chorus Admins can generate the **API key**.


#### Step 1: Generating Your Chorus API Key
1. Log in to your [Chorus account](https://hello.chorus.ai/login).
2. In the navigation menu, click the **Profile** icon, then select **Settings**.
3. In the **Personal Settings** page, scroll down to find **API Access**.
4. Click **Generate API Token**.

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

Once you have the **API Key**:
1. Open the form where you need to authenticate with Chorus.
2. Enter the **API Key** in the designated field.
3. Submit the form, and you should be successfully authenticated.


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

You are now connected to Chorus.

Binary file added docs-v2/integrations/all/chorus/form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion docs-v2/integrations/all/freshsales.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,10 @@ _No setup guide yet._
- When creating a connection, you need to add the subdomain as a connection configuration parameter, for example: `nango.auth('freshsales', 'test-connection-id', {params: {subdomain: '<your-subdomain>'}})`.
- Freshsales enforces rate limit on the account level. For more details check [freshsales rate limit](https://support.freshsales.io/en/support/solutions/articles/223406-does-freshsales-have-api-request-limits-for-an-account-)

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

## Going further

<Card title="Connect to Freshsales" icon="link" href="/integrations/all/freshsales/connect" horizontal>
Guide to connect to Freshsales using Connect UI
</Card>
Binary file added docs-v2/integrations/all/freshsales/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.
39 changes: 39 additions & 0 deletions docs-v2/integrations/all/freshsales/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Freshsales - How do I link my account?
sidebarTitle: Freshsales
---


# Overview

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

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

### Prerequisites:

- You must have an account with Freshsales.

#### Step 1: Finding Your Freshsales API Key
1. Login to your **Freshsales** account. Click on your **Profile picture** and select **Personal Settings**.
<img src="/integrations/all/freshsales/profile.png" />
2. Click on the **API** tab. Your **API Key** will be displayed in **Your API Key** field.
<img src="/integrations/all/freshsales/api_key.png" />


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

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

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


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

You are now connected to Freshsales.
Binary file added docs-v2/integrations/all/freshsales/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/freshsales/profile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs-v2/integrations/all/gainsight-cc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@ _No setup guide yet._
- To view the list of scopes for a given endpoint, please refer to the Authorizations section of that endpoint.
- When creating a new connection in Nango, please provide your `region`. You can find this under `API access information` in Control.
<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/gainsight-cc.mdx)</Note>

## Going further

<Card title="Connect to Gainsight CC" icon="link" href="/integrations/all/gainsight-cc/connect" horizontal>
Guide to connect to Gainsight CC using Connect UI
</Card>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 43 additions & 0 deletions docs-v2/integrations/all/gainsight-cc/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Gainsight CC - How do I link my account?
sidebarTitle: Gainsight CC
---


# Overview

To authenticate with Gainsight CC, you need:
1. **Client ID** - A unique identifier for your client.
2. **Client Secret** - A confidential key used to authenticate the identity of the application (client).
3. **Region** - The specific Gainsight CC region where your data resides.

This guide will walk you through obtaining these credentials within Gainsight CC.

### Prerequisites:

- You must have an account with Gainsight CC.

### Instructions:

#### Step 1: Generating API credentials
1. Login to your Gainsight CC account.
2. Navigate to **Integrations** and select **API**.
3. In the **OAuth2** section, add a name in the **Label** field and click the **Create an OAuth2 client**. A pair of API credentials will be generated for you.
<img src="/integrations/all/gainsight-cc/api-credentials.png" />

#### Step 2: Finding your region
1. Within the **API** section in the **Integrations** section, head to the **API access information** area. Your **Region** will be displayed there.
<img src="/integrations/all/gainsight-cc/region.png" />

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

Once you have the **Client ID**, **Client Secret** and **Region**:
1. Open the form where you need to authenticate with Gainsight CC.
2. Enter the **Client ID**, **Client Secret** and **Region** in their designated fields.
3. Submit the form, and you should be successfully authenticated.


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

You are now connected to Gainsight CC.

Binary file added docs-v2/integrations/all/gainsight-cc/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/gainsight-cc/region.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion docs-v2/integrations/all/gong.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ Gong offers both Basic auth (API key) and OAuth as authentication. Nango impleme
- [API Docs](https://app.gong.io/settings/api/documentation#overview)
- [Oauth-related docs](https://help.gong.io/hc/en-us/articles/13944551222157-Create-an-app-for-Gong)
- [API rate limiting](https://app.gong.io/settings/api/documentation#overview)
- [SCIM API Docs](https://help.gong.io/docs/provision-team-members-from-a-custom-source-scim)
- [Retrieve Access Key and Access Key Secret](https://help.gong.io/docs/receive-access-to-the-api)

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

Expand All @@ -54,6 +56,6 @@ Gong offers both Basic auth (API key) and OAuth as authentication. Nango impleme

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

<Card title="Connect to gong" icon="link" href="/integrations/all/gong/connect" horizontal>
<Card title="Connect to Gong" icon="link" href="/integrations/all/gong/connect" horizontal>
Guide to connect to Gong API using Nango Connect.
</Card>
2 changes: 1 addition & 1 deletion docs-v2/integrations/all/gong/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This guide will walk you through finding or creating those credentials within Go

### Prerequisites:

- You must set up an account with Gong.
- You must set up an administrator account with Gong.

#### Step 1: Finding Gong API Key and API Key Secret
1. Log into your Gong account and navigate to `Company Settings` > `Ecosystem` > `API` and click `Create` to generate the access key and the access key secret.
Expand Down
6 changes: 5 additions & 1 deletion docs-v2/integrations/all/hackerrank-work.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,8 @@ _No setup guide yet._

- HackerRank-Work uses `Basic` auth mode to access different endpoints. Provide your API key as the `Basic` auth username value. You do not need to provide a password.

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

<Card title="Connect to HackerRank Work" icon="link" href="/integrations/all/hackerrank-work/connect" horizontal>
Guide to connect to HackerRank Work using Nango Connect.
</Card>
40 changes: 40 additions & 0 deletions docs-v2/integrations/all/hackerrank-work/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Hackerrank - How do I link my account?
sidebarTitle: Hackerrank
---

# Overview

To authenticate with Hackerrank, you need one key piece of information:
1. **API Key** - Your Hackerrank Work API Key

This guide will walk you through finding or creating those credentials within Hackerrank.

### Prerequisites:

- You must set up an account with Hackerrank.
- An Enterprise plan with a Recruiter license.
- You must have an activated Recruiter-type user account with Company Admin permissions.

#### Step 1: Finding Hackerrank API Key
1. Log into your Hackerrank account.
2. Click the down arrow next to the user icon on the top right corner of the Home page.
3. Click `Settings` from the drop-down menu and then click `API Access` in the left navigation pane.

<img src="/integrations/all/hackerrank-work/h1.png" />

4. On the displayed page, click `New Token`.

<img src="/integrations/all/hackerrank-work/h2.png" />

5. In the New Token dialog box, specify the token label and then click Generate Token.

#### Step 2: Connect Your Hackerrank Account

<img src="/integrations/all/hackerrank-work/nango_connect_ui.png" />

To authenticate using your API credentials, navigate to the Hackerrank authentication form.
Enter your credentials as follows:
- API Key: Your Hackerrank API Key

Click "Connect" to complete the authentication.
Binary file added docs-v2/integrations/all/hackerrank-work/h1.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/hackerrank-work/h2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 39 additions & 0 deletions docs-v2/integrations/all/helpscout-docs/connect.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Help Scout - How do I link my account?
sidebarTitle: Help Scout
---

# Overview

To authenticate with Help Scout, you need one key piece of information:
1. **API Key** - Your Help Scout Work API Key

This guide will walk you through finding or creating those credentials within Help Scout.

### Prerequisites:

- You must set up an account with Help Scout.

#### Step 1: Finding Help Scout API Key
1. Log into your Help Scout account.
2. Each user has a Docs API key. To generate, view, or regenerate the API key, click the "person" icon on the top right of your account, next to the search, then click `Your Profile`.

<img src="/integrations/all/helpscout-docs/help1.png" />

3. Next, click the `Authentication` link in the menu on the left and select the `API Keys` tab.

<img src="/integrations/all/helpscout-docs/help2.png" />

Note: If you don't see an API key in your profile, it's because you haven't been granted the "Docs: Create new, edit settings & Collections" permission by the Account Owner or an Administrator.

4. Store your API key securely.

#### Step 2: Connect Your Help Scout Account

<img src="/integrations/all/helpscout-docs/nango_connect_ui.png" />

To authenticate using your API credentials, navigate to the Help Scout authentication form.
Enter your credentials as follows:
- API Key: Your Help Scout API Key

Click "Connect" to complete the authentication.
Binary file added docs-v2/integrations/all/helpscout-docs/help1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion docs-v2/integrations/all/helpscout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,8 @@ Each user has a Help Scout Docs API key, which is used to authenticate the Docs
- For Help Scout Mailbox, access tokens expires after every 172800 seconds which is equivalent to 2 days, you can use `nango.getConnection()` to generate a new set of tokens.
- Both `helpscout-docs` and `helpscout-mailbox` enforce different rate limits based on your current plan. For more details, please check the rate limiting guidelines for [HelpScout Docs](https://developer.helpscout.com/docs-api/#rate-limiting) and [HelpScout Mailbox](https://developer.helpscout.com/mailbox-api/overview/rate-limiting/).

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

<Card title="Connect to Help Scout" icon="link" href="/integrations/all/helpscout-docs/connect" horizontal>
Guide to connect to Help Scout using Nango Connect.
</Card>
Loading

0 comments on commit 5fc5d05

Please sign in to comment.