Updated HTTP Integration#422
Open
stitenko wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refreshes the HTTP Integration documentation and uplink data converter include to better explain converter behavior, provide reusable scripting patterns, and keep navigation/diagram anchors aligned.
Changes:
- Expanded the uplink data converter include with a short explanation + example and a new “Common Scripting Patterns” section.
- Reworked the HTTP integration include: prerequisites, clearer converter explanation, updated setup steps, security/header filter guidance, and troubleshooting.
- Updated the HTTP integration architecture SVG link to target the new section anchor.
Reviewed changes
Copilot reviewed 2 out of 7 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/content/_includes/docs/user-guide/integrations/uplink-data-converter.mdx | Adds intro/example and a new “Common Scripting Patterns” section for generic converters. |
| src/content/_includes/docs/user-guide/integrations/http.mdx | Restructures HTTP integration guide; adds prerequisites, converter-focused explanations, security and troubleshooting sections. |
| src/assets/images/user-guide/integrations/http-integration.svg | Updates the diagram hyperlink anchor to match the revised HTTP docs heading. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+15
to
+19
| Without an uplink converter, ThingsBoard cannot understand how external HTTP payloads should be interpreted and processed internally. | ||
|
|
||
| Example: | ||
|
|
||
| Incoming HTTP payload: |
Comment on lines
+133
to
+139
| | Payload field | ThingsBoard field | Output type | Notes | | ||
| |---------------|-------------------|-------------|-------| | ||
| | `data.deviceName` | `deviceName` | — | Device identifier; auto-creates the device on first uplink | | ||
| | `data.deviceType` | `deviceType` | — | Device profile name | | ||
| | `data.model` | `model` | attribute | | | ||
| | `data.param2` | `serialNumber` | attribute | Field is renamed in the output | | ||
| | `data.temperature` | `temperature` | telemetry | | |
| | Symptom | Likely cause | Fix | | ||
| |---------|-------------|-----| | ||
| | Telemetry missing in ThingsBoard | Wrong field path in the script | Check **Out** in converter events; verify `data.yourField` matches the actual JSON key | | ||
| | Device not created, `deviceName` is null | Field doesn't exist or has a different name | Add a fallback: `var deviceName = data.id \|\| 'Unknown';` | |
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
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.
Description
Type of change
src/content/docs/**)src/content/_includes/**)src/components/**,src/styles/**)src/pages/**,src/data/**)src/data/redirects.ts)releaseskill)Affected products
Related issues
Checklist
pnpm checkpasses (Astro / TypeScript)pnpm lint:eslintpassespnpm lint:slugcheckpasses (required if pages were added/renamed/moved across languages)pnpm lint:linkcheckpasses locally — required to merge; run it before requesting review (usepnpm lint:linkcheck:nobuildif you already ran a build)src/data/redirects.ts, andpnpm generate:redirectswas runsrc/data/versions.ts