PLUG-4729 Correct Autotask API credential guidance - #123
Conversation
The API Username config field was documented as the API user's email address. It is actually the Username (Key) value in the Credentials section of the Autotask API User record, a separate field that happens to be formatted like an email address. Following the old guidance produced a 401 with no clear cause. Also corrects the API Integration Code, which comes from the API Tracking Identifier section rather than Credentials. - ui.json: name the exact section and field for username, integration code and secret; change the username placeholder so it no longer matches the value the docs now call out as wrong - docs/README.md: correct the creation steps, add a section contrasting the correct and incorrect username, rewrite the credential reference table - metadata.json: bump to 1.0.5 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI (base), Organization UI (inherited) Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (3)
Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour. 📝 WalkthroughWalkthroughThe Autotask plugin updates API credential setup documentation, UI field guidance, zone URL examples, credential mappings, and the plugin metadata version. ChangesAutotask credential guidance
Merge Risk: ⚪ Minimal · up to This change corrects Autotask credential and integration-code guidance without changing runtime behavior; no actionable merge-blocking risk remains after normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Comment |
🧩 Plugin PR Summary📦 Modified Plugins
📋 Results
🔍 Validation Details✅
|
📋 Summary
Fixes incorrect Autotask setup documentation. The API Username field was documented as the API user's email address, but it's actually the Username (Key) value from the Credentials section on the Autotask API User record — a separate value that happens to be formatted like an email address. Following the old guidance produced a 401 with no clear cause. Also corrects the API Integration Code guidance, which comes from the API Tracking Identifier section rather than Credentials.
🔗 Related issue(s)
N/A
🧩 Plugin details
🧪 Testing
squaredup validate/squaredup deploy).Does this PR introduce any breaking changes?
📚 Documentation
✅ Checklist
Summary by CodeRabbit
Documentation
Improvements