Ajax

Consume Ajax API (v.0.1.2)

Actions242

User Actions
- Unbind User From Hub
- Update Bound User Specific Key Pad Password
- Reset Bound User Specific Key Pad Password
- Update Bound User Specific Key Pad Force Disarm Password
- Reset Bound User Specific Key Pad Force Disarm Password
- Update Permission On Behalf Of UserId for BoundUserId on Hub For Single Device
- Get Permission For CompanyId On Hub For Photo By User
- Update Permission On Behalf Of UserId For CompanyId On Hub For Photo
- Get Permission For CompanyId On Hub For Surveillance Cameras
- Update Permission On Behalf Of UserId For CompanyId On Hub For Surveillance Cameras
- Get Bound Company Lists
- Get Bound Company Details
- Update Bound User Details
- Unbind Company Form Hub
- Find User
- Create New User
- Contact Info Confirmation
- Request Password Reset
- Confirm Password Reset
- Get User Info By ID
- Update User Info
- Update User Image
- Delete User Image
- Confirm User Contact Information Change
- Request to Change User's Login
- Request To Change User's Phone
- Request To Change User's Passwords Hash
- Get Bound Users List
- Bind User To The Hub
- Get Bound User Details
- Update Bound User
Monitoring Actions
- Get Monitoring Request From Installers
- Approve Monitoring Request
- Reject Monitoring Request
- Get Hub Attached Security Companies
- Send Binding Request To Security Company
- Send Deletion Request With Security Company
- Get Hub Attached Security Companies For Company
- Send Binding Request To Security Company For Company
- Send Deletion Request With Security Company For Company
- Get Counter Of Monitoring Request From Installers
- Get Counter Of Monitoring Request From Users
- Get Monitoring Request From Users
Invite Actions
- Get Hub Invites
- Revoke Invite
- Get Hub Invites For Company
- Revoke Invite For Company
Network Actions
- Enable/disable Ethernet Network Channel
- Enable/disable WiFi Network Channel
- Enable/disable GSM Network Channel
- Update Wifi Settings
- Get Status Of Update Wifi Settings Operation
- Update Ethernet Settings
- Get Status Of Update Ethernet Settings Operation
- Update General GSM Settings
- Update GSM Sim Card Settings
- Get Status Of Update Sim Card Settings Operation
- Send Get Balance Request
- Get Balance Request Status
- Update GSM Sim Card Balance Number
- Scan Wifi Networks
- Get Scan Wifi Networks
- Join Wifi Networks
- Get Join Wifi Network Operation Status
- Update Device Ethernet Settings
- Get Status Of Update Device Ethernet Settings Operation
- Enable/disable Device Ethernet Network Channel
- Enable/disable Ethernet Network Channel For Company
- Enable/disable WiFi Network Channel For Company
- Enable/disable GSM Network Channel For Company
- Update General GSM Settings For Company
- Update GSM Sim Card Settings For Company
- Get Status Of Update Sim Card Settings Operation For Company
- Send Get Balance Request For Company
- Get Balance request Status For Company
- Update GSM Sim Card Balance Number For Company
Access Control Actions
- Get Access Control Related Async Operation Status
- Exit Card Mode
- Format Access Card
- Get Entity Info
- Unbind Access Control Entity From Hub
- Send Command To Entity
Access Code Actions
- Get Access Codes List
- Create New Access Code
- Get Access Code
- Update Access Code
- Delete Access Code
- Update Access Code Password
- Update Access Code Duress Password
- Delete Access Code Password
- Get Access Codes List For Company
- Create New Access Code For Company
- Get Access Code For Company
- Update Access Code For Company
- Delete Access Code For Company
- Update Access Code Password For Company
- Update Access Code Duress Password For Company
- Delete Access Code Duress Password
Camera Actions
- Get Cameras Linked To Hub
- Link Camera to Hub
- Get Camera Linked To Hub
- Update Camera Settings
- Unlink Camera
Object Actions
- Get Employee Access List
- Get Employee Access
- Updates Employee Access
- Create Employee Access
- Delete Employee Access
- Get Object maintenance Data
- Updates Object Maintenance Data
- Get List Of Objects
- Creates An Object
- Get Object Info
- Delete An Object
- Update Object General Info
- Cancel Object Deletion
- Get Object Notes By Object Id
- Create Object Note
- Get Object Notes By Id
- Update Object Note
- Delete Object Note
- Get Responsible Persons By Object Id
- Get Object Responsible Person By Id
- Get All Object Media By Object Id
- Create Object Media For Object Id
- Get Object Media By Id
- Delete Object Media By Id
Hub Actions
- Get Hubs Binding Info
- Create Hub
- Get Hub Detailed Info and Settings
- Update Hub Image
- Delete Hub Image
- Get User Role On Hub
- Get Hub Logs
- Delete Hub Logs
- Clean Hub Cache
- Cancel Device Search
- Send Panic Command
- Get Hub Two-Stage Arming Operation Status
- Control Hub Arm State
- Start Update Firmware Process
- Set Groups Mode On or Off For Hub
- Reset Sim Traffic Counter
- Request Arming Reset
- Reset Arming
- Mute Fire Detectors
- Switch On Demand Photo Mode
- Search Among The Hubs Attached To Company
- Get Hub Detailed Info For Company
- Update Hub Image for Company
- Send Panic Command For Company
- Control Hub Arm State For Company
- Temporarily Do Not Inform User About Problems For Company
- Execute Power Test Command
- Execute Buses Power Command
- Execute Set Password Length Command
- Temporarily Do Not Inform User About Problems
- Create An Object For Locked Hub
- Get Hub Billing Info For Each Company
- Get Permission For CompanyId On Hub For Photo
- Mark Object As Vacant By Company
- Unmark Object As Vacant By Company
- Get Hub Logs For Company
Room Actions
- Get Rooms List
- Create New Room
- Get Room Info
- Update Room Info
- Delete Room
- Update Room image
- Delete Room Image
- Get Room List
- Get Room Info For Company
Group Actions
- Get Groups List
- Create New Group
- Get Group Info
- Update Group Detailed Info
- Delete Group
- Update Group Image
- Delete Group Image
- Get Group Two-Stage Arming Operation Status
- Control Hub Arm State
- Get Group List
- Get Group Detailed Info
- Control Hub Arm State For Company
Security Management Actions
- Get Hub's Security Managements
- Get Hub's Security Managements For Company
Device Actions
- Get Devices List
- Get Device Info
- Update Device Info
- Unlink Device From Hub
- Send Command To Device
- Send Command To Bind Device To Range Extender
- Send Command To Unbind Device To Range Extender
- Get Devices List For Company
- Get Device Info For Company
- Update Device Info For Company
- Send Command To Device For Company
- Execute Scan Fibra Devices Command
- Get Scan Fibra Device List
Pro Actions
- Find User
- Create New Pro
- Contact Info Confirmation
- Request Password reset
- Confirm Password Reset
- Get Current Access Request
- Update Current Access Request
Installation Actions
- Send Request For Add On Installation Hub To Company
- Invite Installation Company To Hub
- Get Hubs On Installation For Company
- Invite Installation Company By Company
- Send Request For Delete Own Installation Company
- Send Claim Installation Permissions For Company
Employee Management Actions
- Get List Of Employees
- Invites An Employee
- Get A Certain Employee
- Delete An Employee
- Updates Company Employee
- Update Employee Image
RRU Code Actions
- Get RRU Codes List
- Create New RRU Code
- Get RRU Code
- Update RRU Code
- Delete RRU Code
- Update RRU Code Password
Agreement Actions
- Get Object Is Vacant Legal Agreement
Ring Management Actions
- Get Hub's Buses
- Manage Rings Connections
Rapid Response Unit Actions
- Get All Rapid Response
- Create Rapid Response Unit
- Get Certain Rapid Response Unit
- Delete Rapid Response Unit
- Update Rapid Response Unit
Receiver Actions
- Find All Company Receivers
- Create Receiver For Given Company
- Get Receiver By Id
- Update Receiver For The Given Company
- Delete Receiver For Given Company
- Find Paginated Receiver To Hub Bindings
- Get Receiver To Hub Binding
- Bind Hub To The Receiver
- Update Hub To Receiver Binding
- Delete Hub To Receiver Binding

Overview

This node, named "Ajax," is designed to interact with the Ajax API (version indicated in the code). It supports multiple resources and operations, including the "Installation" resource with the operation "Invite Installation Company To Hub." The primary function of this operation is to send an invitation to a specified installation company to join a particular hub within the Ajax system.

Common scenarios for using this node include automating the management of installation companies by inviting them programmatically to hubs, which can be useful in large-scale deployments or integrations where manual invitations would be inefficient. For example, a security service provider could automate onboarding new installation partners into their monitoring hubs.

Properties

Name	Meaning
User Id	The identifier of the user initiating or associated with the invitation.
Hub Id	The identifier of the hub to which the installation company is being invited.
Company Hex Id	The unique hexadecimal identifier of the installation company to invite to the hub.

These properties are required inputs when performing the "Invite Installation Company To Hub" operation under the "Installation" resource.

Output

The node outputs JSON data representing the result of the invitation operation. This typically includes confirmation details such as success status, any returned identifiers, or error messages if the invitation failed. The exact structure depends on the Ajax API response but generally confirms whether the invitation was successfully sent.

If the node handles binary data, it would relate to attachments or media associated with the invitation, but based on the provided code and operation, no binary output is expected.

Dependencies

Requires an API key credential for authenticating with the Ajax API.
Depends on the external Ajax API service to perform operations.
Uses internal helper classes for HTTP requests, state management, and operation resolution.
The node expects proper configuration of the API credentials within n8n.

Troubleshooting

Authentication errors: Ensure that the API key credential is correctly configured and has sufficient permissions.
Invalid IDs: Errors may occur if userId, hubId, or companyHexId are incorrect or do not exist in the Ajax system.
Network issues: Connectivity problems with the Ajax API endpoint can cause failures; verify network access.
API limits or restrictions: The Ajax API might enforce rate limits or require specific roles; check API documentation and account settings.
Error messages from API: The node will relay error messages from the Ajax API; review these messages to understand issues like invalid parameters or unauthorized access.

Links and References

Ajax API Documentation (general reference for the Ajax API)
n8n Documentation on Creating Custom Nodes
Relevant API authentication setup guides within n8n for managing API keys and credentials

AjaxInstall