Skip to content

edgeuno/n8n-nodes-zoho-sprints

Repository files navigation

Zoho Sprints n8n Community Node

This package provides an n8n node named Zoho Sprints to interact with the Zoho Sprints REST API (/zsapi) using OAuth2 credentials.

Resource and Operation Mapping

Implemented resources and operations:

  • Workspace
    • Get Many: list workspaces (GET /teams/)
    • Get: workspace settings (GET /team/{teamId}/settings/)
    • Create / Update: workspace tag create/edit (POST /team/{teamId}/tag/, POST /team/{teamId}/tag/{tagId}/)
  • Project: Get, Get Many, Create, Update
  • Sprint: Get, Get Many, Create, Update
  • Item (work item): Get, Get Many, Create, Update
  • Task: implemented as item specialization over item endpoints (Zoho Sprints does not expose a separate top-level task endpoint)
  • User: Get, Get Many, Create, Update (role update at workspace scope)
  • Comment: Get, Get Many, Create, Update for item/sprint entities

OAuth2 Setup (Zoho)

  1. In Zoho API Console, create a Server-based app.
  2. Configure redirect URI from your n8n OAuth callback.
  3. Use Zoho Sprints scopes (minimum for this node):
    • ZohoSprints.teams.READ,ZohoSprints.teams.CREATE,ZohoSprints.teams.UPDATE
    • ZohoSprints.projects.READ,ZohoSprints.projects.CREATE,ZohoSprints.projects.UPDATE
    • ZohoSprints.sprints.READ,ZohoSprints.sprints.CREATE,ZohoSprints.sprints.UPDATE
    • ZohoSprints.items.READ,ZohoSprints.items.CREATE,ZohoSprints.items.UPDATE
    • ZohoSprints.comments.READ,ZohoSprints.comments.CREATE,ZohoSprints.comments.UPDATE
    • ZohoSprints.teamusers.READ,ZohoSprints.teamusers.CREATE,ZohoSprints.teamusers.UPDATE
    • ZohoSprints.projectusers.READ,ZohoSprints.projectusers.CREATE
    • ZohoSprints.settings.READ
  4. In n8n, create credential Zoho Sprints OAuth2 API and select the correct data center.

Build and Local Installation

npm install
npm run build

To link into a local n8n instance:

# from this repository
npm link

# from your n8n user folder or custom nodes environment
npm link n8n-nodes-zoho-sprints

Then restart n8n.

Pagination and Error Handling

  • Pagination follows Zoho Sprints index/range and next/nextIndex (or next_index) patterns.
  • Retries with exponential backoff are applied for transient failures (429, 502, 503, 504) and Zoho code 7421.
  • Errors are normalized into n8n-friendly output (message, code, statusCode, details).
  • Node supports Continue On Fail.

Manual Verification Checklist

  1. Credential test: create credential, ensure /teams/ succeeds.
  2. Workspace Get Many: expect array of portal/team records.
  3. Project Get Many: set workspace, expect project records with mapped fields.
  4. Sprint Create + Get: create sprint, then fetch by ID.
  5. Item Create + Update: create work item and update assignees.
  6. Task Create: leave item type empty; node auto-resolves Task item type when available.
  7. User Get Many (Workspace): verify action=data listing and pagination.
  8. Comment Create + Update: for item or sprint using module ID, verify note ID appears and can be updated.

Notes on API Ambiguities

  • Some endpoints rely on parameter-driven actions (action=data, action=details, action=addnotes) instead of distinct paths.
  • Task behavior is implemented via item endpoints and item type mapping, based on Get item types output.
  • Response structures differ by endpoint (indexed maps like itemJObj + item_prop); node normalizes these into record arrays where possible.

About

n8n zoho sprints node

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors