addigy

n8n community node for Addigy API integration

Package Information

Released: 7 mo ago
Downloads: 45 weekly / 128 monthly
Latest Version: 0.0.7
Author: Joshua Smith

Documentation

n8n-nodes-addigy

Addigy logo

n8n-nodes-addigy is an n8n community node for working with the Addigy API v2.

n8n is a fair-code licensed workflow automation platform.

Table of Contents

Installation

Follow the installation guide in the n8n community nodes documentation.

GUI

  1. Go to Settings > Community Nodes
  2. Select Install
  3. Enter @joshuanode/n8n-nodes-addigy in Enter npm package name
  4. Agree to the risks of using community nodes
  5. Select Install

Manual Installation

To get started install the package in your n8n root directory:

npm install @joshuanode/n8n-nodes-addigy

For Docker-based deployments add the following line before the font installation command in your n8n Dockerfile:

RUN cd /usr/local/lib/node_modules/n8n && npm install @joshuanode/n8n-nodes-addigy

Prerequisites

  • n8n installed
  • An active Addigy account
  • Addigy API v2 credentials
  • Your Addigy organization ID

Credentials

To use this node, you'll need to configure your Addigy API credentials in n8n.

Generating API v2 Credentials

  1. Log in to your Addigy account
  2. Navigate to Account > API Tokens
  3. Click Create New Token
  4. Give your token a descriptive name (e.g., "n8n Integration")
  5. Select the permissions required for the resources you plan to automate
  6. Click Create Token
  7. Copy the generated token immediately (you won't be able to see it again)

Configuring Credentials in n8n

  1. In your n8n workflow, add an Addigy node
  2. Click on Create New Credential
  3. Enter your API Token
  4. Enter your Organization ID
  5. Enter your Addigy base URL if you are not using the default https://api.addigy.com
  6. Click Save

The credential test uses the Addigy permissions endpoint.

Compatibility

  • Tested locally with the current n8n community node toolchain in this repository
  • Works with Addigy API v2
  • Compatible with self-hosted and cloud n8n instances

Features

This node exposes the Addigy operations implemented in this repository today. Several actions are limited by what Addigy currently exposes through API v2, so the README intentionally documents the implemented behavior rather than the full Addigy product surface.

Resources

The Addigy node supports the following resources:

🖥️ Device

Manage and monitor Apple devices in your organization.

  • Get device information by ID
  • List all devices with filtering options
  • Count total devices with optional filters
  • Get device facts
  • Reassign a device to a policy
  • Run commands on devices (restart, shutdown, lock, clear passcode, refresh facts)

📋 Policy

Organize devices into policies with specific configurations.

  • Create new policies
  • Get policy details
  • List all policies
  • Update policy information
  • Delete policies

🚨 Alert

Monitor and respond to alerts from your device fleet.

  • Get alert details
  • List alerts with filters (device, status, severity, date range)
  • Resolve alerts

📦 Application

Deploy and manage applications across your device fleet.

  • Get application information
  • List available smart software
  • Assign smart software to a policy
  • Remove smart software from a policy

📊 Fact

Create and manage custom facts to collect device information.

  • Create custom facts
  • Get fact definitions
  • List all custom facts
  • Update fact metadata
  • Delete custom facts

⚙️ Instruction

Create and execute custom scripts on devices.

  • Create reusable instruction scripts
  • Get instruction details
  • List all instructions
  • Delete instructions
  • Execute instructions on a specific device

💳 Billing

Access billing data for your organization.

  • Get billing summary data
  • Get billing account details
  • Get billing invoices

Usage

Basic Example: Get All Devices

  1. Add an Addigy node to your workflow
  2. Select Device as the resource
  3. Select Get Many as the operation
  4. Configure filters if needed
  5. Execute the workflow

Advanced Example: Automated Alert Response

Create a workflow that monitors for critical alerts and resolves them after running a remediation instruction on the affected device:

  1. Schedule Trigger: Run every 5 minutes
  2. Addigy Node (Get Alerts):
    • Resource: Alert
    • Operation: Get Many
    • Filters: Status = Open (Unattended), Severity = Critical
  3. IF Node: Check if alerts exist
  4. Addigy Node (Execute Instruction):
    • Resource: Instruction
    • Operation: Execute
    • Select remediation instruction
    • Target: Device (from alert data)
  5. Addigy Node (Resolve Alert):
    • Resource: Alert
    • Operation: Resolve
    • Alert ID: From alert data
    • Notes: "Automatically resolved via n8n workflow"

Example Workflows

1. Device Onboarding Automation

Automatically assign new devices to the correct policy based on device type:

Webhook Trigger → Addigy (Get Device) → Switch (by device type) → Addigy (Update Device - assign policy) → Slack (notify team)

2. Software Deployment Campaign

Deploy an application to all devices in a specific policy:

Manual Trigger → Addigy (Get Policy) → Addigy (Deploy Application) → Email (send deployment report)

3. Custom Fact Collection and Reporting

Collect custom facts from devices and generate a report:

Schedule Trigger → Addigy (Get Many Devices) → Addigy (Get Facts) → Google Sheets (append data) → Slack (send summary)

4. Compliance Monitoring

Monitor devices for compliance issues and create tickets:

Schedule Trigger → Addigy (Get Alerts) → Filter (compliance alerts) → Jira (create issue) → Addigy (add alert notes)

Operations

Device Operations

Operation Description
Count Get total number of devices
Get Retrieve a device by ID
Get Many List devices with optional filters
Get Facts Retrieve all facts for a specific device
Update Assign a device to a policy
Run Command Execute commands (restart, shutdown, lock, etc.)

Policy Operations

Operation Description
Create Create a new policy
Get Retrieve a policy by ID
Get Many List all policies
Update Update policy properties
Delete Delete a policy

Alert Operations

Operation Description
Get Retrieve an alert by ID
Get Many List alerts with filters
Resolve Mark an alert as resolved

Application Operations

Operation Description
Get Retrieve an application by ID
Get Many List available smart software
Deploy Assign smart software to a policy
Remove Remove smart software from a policy

Fact Operations

Operation Description
Create Create a custom fact
Get Retrieve a custom fact by name
Get Many List all custom facts
Update Update a custom fact
Delete Delete a custom fact

Instruction Operations

Operation Description
Create Create a new instruction
Get Retrieve an instruction by ID
Get Many List all instructions
Delete Delete an instruction
Execute Run an instruction on a device

Billing Operations

Operation Description
Get Data Retrieve billing summary data
Get Account Retrieve billing account details
Get Invoices Retrieve billing invoices

Known Issues

  • Rate Limiting: The Addigy API has a rate limit of 1,000 requests per 10 seconds. If exceeded, requests will be rejected for 24 hours. The node does not currently implement automatic rate limiting.
  • Pagination: When fetching large datasets, be mindful of performance. Use the "Return All" option carefully.
  • API v2 Gaps: Some Addigy product actions are not exposed as direct API v2 endpoints. In those cases the node exposes the closest supported workflow-safe behavior and labels the operation accordingly.

Resources

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Support

If you encounter any issues or have questions:

License

MIT


About Addigy

Addigy is a full-featured Apple MDM (Mobile Device Management) platform that helps organizations manage Mac, iPhone, iPad, and Apple TV devices. Learn more at addigy.com.

Disclaimer

This is an unofficial community node and is not affiliated with or endorsed by Addigy. Use at your own risk.

Discussion