team-dynamix

n8n community node for TeamDynamix API

Package Information

Downloads: 69 weekly / 69 monthly
Latest Version: 0.1.6
Author: Ernie Francis

Available Nodes

Team Dynamix icon
Team Dynamix
Work with TeamDynamix tickets and knowledge base articles

Documentation

n8n-nodes-team-dynamix

An n8n community node package providing integration with the TeamDynamix API for ticket management and knowledge base operations.

Status: n8n Community Node Package | Node Type: Integration | License: MIT

For developers and collaborators: This repository follows n8n community node standards and publishing requirements. See N8N_COMMUNITY_NODE_REQUIREMENTS.md and CONTRIBUTING.md for detailed information.

Features

  • TeamDynamix API Credential - Multiple authentication modes (User Login, Admin Login, Token)
  • Ticket Operations:
    • Create tickets
    • Get many tickets (with filtering and pagination)
    • Update tickets
    • Delete tickets
    • Add feed entries to tickets
  • Knowledge Base Operations: KB article access
  • Automatic Publishing: CI/CD pipeline publishes to npm after main updates
  • Manual Versioning Control: package.json version is intentionally managed by maintainers via develop -> main PRs

Installation

From npm (for n8n users)

Follow the n8n community node installation guide:

Package name:

n8n-nodes-team-dynamix

For local development

npm install

Local Development

Start n8n with this node loaded and hot-reloaded:

npm run dev

Useful commands:

npm run lint
npm run lint:fix
npm run build

Docker Development

Run the development environment in Docker:

# Build and start the container
npm run docker:dev

# Or run in detached mode (background)
npm run docker:dev:detached

# View logs
npm run docker:logs

# Stop the container
npm run docker:stop

The n8n instance will be available at: http://localhost:5678

Docker setup includes:

  • Automatic hot-reload for code changes
  • Persistent n8n data volume
  • Debug logging enabled

Credentials

Credential type: TeamDynamix API (teamDynamixApi)

Supported auth modes:

  • User Login
  • Admin Login
  • Existing Token (Manual)

Configure your TeamDynamix base URL and whichever auth fields apply to your mode.

Operations

Resource: Ticket

  • Create
    • Mode: Guided Fields or Raw JSON
    • Endpoint: POST /tickets
  • Get Many
    • Endpoint: POST /tickets/search
    • Uses Search Data JSON body to refine results
  • Update
    • Endpoint: PUT /tickets/{ticketId}
  • Delete
    • Endpoint: DELETE /tickets/{ticketId}
  • Add Feed
    • Endpoint: POST /tickets/{ticketId}/feed

Resource: KB Article

  • Get Many
    • Endpoint: POST /knowledgebase/articles/search
    • Uses KB Search Data JSON body to refine results

Example KB Search Data payload:

{
	"StatusIDs": [],
	"SearchText": "onboarding",
	"MaxResults": 25
}

All requests are made against your configured credential baseUrl.

Compatibility

  • Node.js 22+
  • Built with @n8n/node-cli

Contributing

We welcome contributions! Before contributing, please see:

Quick Setup for Development

npm install                # Install dependencies
npm run dev               # Start with hot reload
npm run lint             # Check code quality
npm run build            # Build distribution

Publishing

This package is automatically published to npm on pushes to main via GitHub Actions.

Version numbers are not auto-bumped by workflows. Maintainers must manually update package.json before merge, and PR checks enforce that the version is increased for develop -> main pull requests.

Setup required: Configure npm Trusted Publisher (OIDC) for this repository and workflow.

Important: All n8n community nodes must follow publishing requirements, including:

  • ✅ Automatic linting and building on all commits
  • ✅ Publishing to npm registry with proper authentication
  • ✅ Publishing with GitHub Actions and provenance statement

See N8N_COMMUNITY_NODE_REQUIREMENTS.md for full publishing standards.

Required for n8n Submission

Before submitting this package to the n8n Creator Portal, confirm:

  • ✅ Package name follows n8n-nodes-* convention
  • ✅ Includes n8n-community-node-package keyword
  • ✅ package.json includes valid n8n configuration
  • ✅ No runtime dependencies (devDependencies only)
  • ✅ npm run lint and npm run build both pass
  • ✅ Published to npm via GitHub Actions with provenance
  • ✅ README includes installation, credentials, and operations details

Submission details: https://creators.n8n.io/nodes

Resources

License

MIT

Discussion