n8n-nodes-example-service

Community nodes for n8n demonstrating OAuth2 integrations. The package ships with nodes for the public JSONPlaceholder API and the NinjaOne platform.

Installation

Follow the community node installation guide and install the package:

npm install n8n-nodes-example-service

Nodes

Example Service

Basic CRUD operations for the JSONPlaceholder test API.

• Get Many – Retrieve a list of posts
• Get – Fetch a single post by ID
• Create – Create a new post

NinjaOne

Interact with the NinjaOne API.

• Device – Retrieve devices, jobs, alerts and more
• Webhook – Create, update or delete a webhook
• Related Item – Manage relations between entities
• Ticket – Create, update and comment on tickets
• System – Query system entities like policies or users
• Location – Read and update location custom fields
• Organization – Retrieve organizations and related resources
• Backup – Create and list backup jobs
• Knowledge Base – Manage knowledge base articles and folders
• Group – Get device IDs for a group
• Query – Run device queries such as antivirus status or health
• Organization Document – Manage organization documents
• Document Template – Manage document templates
• Checklist Template – Manage checklist templates
• Organization Checklist – Manage client checklists
• Asset Tag – Create and manage asset tags
• Vulnerability – Upload scan data and list groups
• Custom Field – Obtain signed URLs for custom field content
• Management – Advanced management operations (e.g. maintenance)

NinjaOne Legacy

Legacy HMAC based authentication for older NinjaOne API versions.

• Customer – List customers or retrieve a customer by ID

Creating a Ticket

Use the Create operation on the Ticket resource. A minimal payload matching the NewTicket schema is:

{
  "clientId": 1,
  "ticketFormId": 1,
  "subject": "CPU with problems",
  "description": {
    "public": true,
    "body": "new ticket description"
  }
}

Additional optional fields such as severity, priority and tags can be provided.

Authorization Workflow

The NinjaOne Public API uses OAuth 2.0. Redirect the user to https://app.ninjarmm.com/ws/oauth/authorize with the required parameters. Exchange the authorization code for an access token by sending a POST request to https://app.ninjarmm.com/ws/oauth/token. Use the received access_token in the Authorization: Bearer header for all subsequent requests.

Credentials

Create credentials of type Example Service OAuth2 API, NinjaOne OAuth2 API or NinjaOne Legacy API. n8n handles token generation and signing for you.

Compatibility

• Minimum n8n version: 1.38.0
• Tested on Node.js 20

Usage

After installation and credential setup the nodes appear under Community Nodes in the editor. Add a node, select the credentials and choose an operation.

Resources

• n8n community nodes documentation
• NinjaOne API documentation
• JSONPlaceholder API

Development Notes

The Webhook resource is fully functional. Implementation of some related item and location custom field endpoints is pending. The new-node-feature-docs/ directory contains reference API method lists for additional features.