Skip to content

PLUG-4729 Correct Autotask API credential guidance - #123

Merged
TimWheeler-SQUP merged 1 commit into
mainfrom
work/tw/PLUG-4729
Aug 21, 2026
Merged

PLUG-4729 Correct Autotask API credential guidance#123
TimWheeler-SQUP merged 1 commit into
mainfrom
work/tw/PLUG-4729

Conversation

@TimWheeler-SQUP

@TimWheeler-SQUP TimWheeler-SQUP commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

📋 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

  • Plugin name: Autotask
  • Type of change:
    • Bug fix
    • New datastream
    • Enhancement to existing datastream
    • Performance improvement
    • Documentation / metadata / logo
    • Other (please describe):

🧪 Testing

  • Validated and deployed v1.0.5 to a live SquaredUp tenant (squaredup validate / squaredup deploy).
  • Manually followed the corrected API User creation steps against a real Autotask account and confirmed the Username (Key) value resolves the 401 that the old (email address) guidance produced.

⚠️ Breaking changes

Does this PR introduce any breaking changes?

  • No
  • Yes (please describe):

📚 Documentation

  • Documentation updated
  • No documentation changes needed

✅ Checklist

  • This PR changes a single plugin only
  • No secrets or credentials included
  • Plugin, datastream and UI naming follow SquaredUp guidelines
  • I agree to the Code of Conduct

Summary by CodeRabbit

  • Documentation

    • Updated Autotask API user setup instructions with current navigation, credential generation steps, username distinctions, error guidance, and zone URL examples.
    • Clarified credential references and tracking identifiers.
  • Improvements

    • Updated credential field labels, placeholders, and help text for API username keys, integration codes, and generated secrets.
    • Updated the Autotask plugin version to 1.0.5.

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>
@TimWheeler-SQUP
TimWheeler-SQUP requested a review from a team August 20, 2026 20:16
@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: e7f5c379-c7ee-4987-b13a-7aaeae5e6106

📥 Commits

Reviewing files that changed from the base of the PR and between 5e6bf5b and 62fd253.

📒 Files selected for processing (3)
  • plugins/AutoTask/v1/docs/README.md
  • plugins/AutoTask/v1/metadata.json
  • plugins/AutoTask/v1/ui.json

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.


📝 Walkthrough

Walkthrough

The Autotask plugin updates API credential setup documentation, UI field guidance, zone URL examples, credential mappings, and the plugin metadata version.

Changes

Autotask credential guidance

Layer / File(s) Summary
Credential workflow and field guidance
plugins/AutoTask/v1/docs/README.md, plugins/AutoTask/v1/ui.json, plugins/AutoTask/v1/metadata.json
The documentation and UI help text now identify the generated Username (Key), Password (Secret), API Tracking Identifier, and their locations. The documentation distinguishes the API username from the account email address and records the updated setup workflow. The plugin version changes to 1.0.5.

Merge Risk: ⚪ Minimal · up to 62fd2

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)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change to Autotask API credential guidance.
Description check ✅ Passed The description provides a clear summary, plugin details, testing evidence, breaking-change status, documentation status, and checklist.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

🧩 Plugin PR Summary

📦 Modified Plugins

  • plugins/AutoTask/v1

📋 Results

Step Status
Scope & version ✅ Passed
Validation ✅ Passed
Deployment 🚀 Deployed

🔍 Validation Details

autotask
{
  "valid": true,
  "pluginName": "autotask",
  "pluginType": "cloud",
  "summary": {
    "Data Streams": 13,
    "Import Definitions": 1,
    "Correlation Rules": 0,
    "UI Configuration": true,
    "Has Icon": true,
    "Has Default Content": true,
    "Config Validation": true,
    "Custom Types": true
  }
}

@TimWheeler-SQUP
TimWheeler-SQUP requested a review from clarkd August 20, 2026 20:24
@TimWheeler-SQUP
TimWheeler-SQUP merged commit 4c77c79 into main Aug 21, 2026
1 check passed
@TimWheeler-SQUP
TimWheeler-SQUP deleted the work/tw/PLUG-4729 branch August 21, 2026 08:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants