Skip to content

docs: new integrations method #4004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 12, 2025
Merged

docs: new integrations method #4004

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e9345f4
docs: new integrations method
bodinsamuel May 7, 2025
1b308cf
typo
bodinsamuel May 7, 2025
22df994
Merge branch 'master' into sam/25_05_07/docs/node-integrations
bodinsamuel May 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 29 additions & 56 deletions docs-v2/reference/sdks/node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,6 @@ await nango.getIntegration(<INTEGRATION-ID>);
<ResponseField name="include" type="array">
Include sensitive data. Allowed values: `webhook`
</ResponseField>

<ResponseField name="providerConfigKey" type="string" required deprecated>
The integration ID.
</ResponseField>

<ResponseField name="includeIntegrationCredentials" type="boolean" deprecated>
Defaults to `false`.
</ResponseField>
</Expandable>

**Example Response**
Expand All @@ -204,6 +196,9 @@ await nango.getIntegration(<INTEGRATION-ID>);
Create a new integration.

```js
await nango.createIntegration({ provider: <PROVIDER-ID>, unique_key: <UNIQUE_KEY>, [...] });

// Deprecated
await nango.createIntegration(<PROVIDER-ID>, <INTEGRATION-ID>);
```

Expand All @@ -214,92 +209,73 @@ await nango.createIntegration(<PROVIDER-ID>, <INTEGRATION-ID>);
The ID of the API provider in Nango (cf. [providers.yaml](https://nango.dev/providers.yaml) for a list of API provider IDs.)
</ResponseField>

<ResponseField name="providerConfigKey" type="string" required>
<ResponseField name="unique_key" type="string" required>
The integration ID.
</ResponseField>

<ResponseField name="credentials" type="Record<string, string>">
The credentials to include depend on the specific integration that you want to create.
<ResponseField name="display_name" type="string">
The display name of this integration
</ResponseField>

<ResponseField name="credentials" type="Record<string, string>">
<Expandable title="credentials" defaultOpen>
<ResponseField name="oauth_client_id" type="string">
The OAuth client ID.
</ResponseField>

<ResponseField name="oauth_client_secret" type="string">
The OAuth client secret.
</ResponseField>

<ResponseField name="oauth_scopes" type="string">
The list of OAuth scopes
</ResponseField>
</Expandable>
</ResponseField>
The credentials to include depend on the specific integration that you want to create.
</ResponseField>
</Expandable>

**Example Response**

<Expandable>
```json
{
"config": {
"data": {
"unique_key": "slack-nango-community",
"provider": "slack"
"provider": "slack",
"logo": "http://localhost:3003/images/template-logos/slack.svg",
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
}
}
```
</Expandable>

### Update an integration

Edits an integration (only for OAuth APIs).
Patch an integration, all fields are optional.

```js
await nango.updateIntegration({ uniqueKey: <UNIQUE_KEY> }, { [...body] });

// Deprecated
await nango.updateIntegration(<PROVIDER-ID>, <INTEGRATION-ID>);
```

**Parameters**

<Expandable>
<ResponseField name="provider" type="string" required>
The ID of the API provider in Nango (cf. [providers.yaml](https://nango.dev/providers.yaml) for a list of API provider IDs.)
<ResponseField name="unique_Key" type="string">
The integration ID.
</ResponseField>

<ResponseField name="providerConfigKey" type="string" required>
The integration ID.
<ResponseField name="display_name" type="string">
The display name of this integration
</ResponseField>

<ResponseField name="credentials" type="Record<string, string>">
The credentials to include depend on the specific integration that you want to create.
</ResponseField>

<ResponseField name="credentials" type="Record<string, string>">
<Expandable title="credentials" defaultOpen>
<ResponseField name="oauth_client_id" type="string">
The OAuth client ID.
</ResponseField>

<ResponseField name="oauth_client_secret" type="string">
The OAuth client secret.
</ResponseField>

<ResponseField name="oauth_scopes" type="string">
The list of OAuth scopes
</ResponseField>
</Expandable>
</ResponseField>
</Expandable>

**Example Response**

<Expandable>
```json
{
"config": {
"data": {
"unique_key": "slack-nango-community",
"provider": "slack"
"provider": "slack",
"logo": "http://localhost:3003/images/template-logos/slack.svg",
"created_at": "2023-10-16T08:45:26.241Z",
"updated_at": "2023-10-16T08:45:26.241Z",
}
}
```
Expand All @@ -310,13 +286,13 @@ await nango.updateIntegration(<PROVIDER-ID>, <INTEGRATION-ID>);
Deletes a specific integration.

```js
await nango.deleteIntegration(<INTEGRATION-ID>);
await nango.deleteIntegration(<UNIQUE_KEY>);
```

**Parameters**

<Expandable>
<ResponseField name="providerConfigKey" type="string" required>
<ResponseField name="uniqueKey" type="string" required>
The integration ID.
</ResponseField>
</Expandable>
Expand All @@ -326,10 +302,7 @@ await nango.deleteIntegration(<INTEGRATION-ID>);
<Expandable>
```json
{
"config": {
"unique_key": "slack-nango-community",
"provider": "slack"
}
"success": true
}
```
</Expandable>
Expand Down
Loading