Skip to content
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

docs(sdk): add getIntegration #3112

Merged
merged 2 commits into from
Dec 4, 2024
Merged

docs(sdk): add getIntegration #3112

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dc2bfb7
docs(sdk): add getIntegration
bodinsamuel Dec 4, 2024
c98de88
Merge branch 'master' into sam/24_12_04/docs/sdk-get-integration
bodinsamuel Dec 4, 2024
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
22 changes: 22 additions & 0 deletions docs-v2/reference/scripts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,28 @@ await nango.triggerAction('<ACTION-NAME>', { 'custom_key1': 'custom_value1' });

_TbD_

# Get Integration

Returns the current integration information

```js
await nango.getIntegration();
```

With credentials

```js
await nango.getIntegration({ include: ['credentials'] });
```

**Parameters**

See `GET /integrations/{uniqueKey}` query parameters: [documentation](/reference/api/integration/get)
Copy link
Collaborator

@TBonnin TBonnin Dec 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we use this see API ENDPOINT doc page ... pattern for any other method? Should we?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, and I don't know.
Honestly, those docs are annoying to maintain and got lazy but it's also the first one where the api and the method matches perfectly


**Response**

See `GET /integrations/{uniqueKey}` response: [documentation](/reference/api/integration/get)

# Manage connection metadata

### Get connection metadata
Expand Down
Loading