docs: new integrations method #4004
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Your mrge subscription is currently inactive. Please reactivate your subscription to receive AI reviews and use mrge. |
![propel-code-bot[bot]](https://avatars.githubusercontent.com/in/1179004?s=60&v=4){kind=small}
TBonnin
approved these changes
May 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
This PR updates the Node SDK documentation to reflect changes in the integration API. It introduces a new object parameter format for creating and updating integrations, while marking the old method as deprecated. Parameter naming convention has been changed from 'providerConfigKey' to 'unique_key', and response formats now include more details with the structure changed from 'config' to 'data'.
Key Changes:
• Added documentation for new integration creation method with object parameter format
• Renamed parameter 'providerConfigKey' to 'unique_key' throughout documentation
• Marked old integration methods as deprecated
• Updated response examples to reflect new API structure (from 'config' to 'data')
Affected Areas:
• Node SDK documentation (docs-v2/reference/sdks/node.mdx)
This summary was automatically generated by @propel-code-bot