HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node integrates with the HaloPSA API to create a new agent record. It is useful in scenarios where you want to automate the onboarding of support or service agents into the HaloPSA system, such as syncing user data from an HR system or CRM, or programmatically managing agent accounts based on business workflows.

Practical examples include:

  • Automatically creating a new support agent when a new employee joins the company.
  • Adding agents in bulk from an external database.
  • Integrating with other systems to keep agent information up-to-date without manual entry.

Properties

Name Meaning
Email Address The email address for the new agent (required).
Name The full name of the new agent (required).
Additional Fields Optional extra details about the agent:
- Active Whether the agent is active (true/false).
- Department ID Numeric ID representing the department the agent belongs to.
- First Name The first name of the agent.
- Is Admin Whether the agent has administrative privileges (true/false).
- Last Name The last name of the agent.
- Login Name The login username for the agent.
- Phone Number The phone number of the agent.
- Team ID Numeric ID representing the team the agent belongs to.

Output

The node outputs JSON data representing the newly created agent object as returned by the HaloPSA API. This typically includes the agent's unique identifier, email, name, status, and any other fields accepted during creation.

If the API supports it, binary data output is not expected for this operation.

Dependencies

  • Requires an API key credential for authenticating with the HaloPSA API.
  • The node depends on the HaloPSA API being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common Issues:

    • Missing required fields (Email Address, Name) will cause the API request to fail.
    • Invalid or expired API credentials will result in authentication errors.
    • Providing invalid IDs for Department or Team may cause the API to reject the request.
    • Network connectivity issues can prevent communication with the HaloPSA API.

  • Error Messages:

    • Authentication errors usually indicate invalid API keys; verify and update credentials.
    • Validation errors from the API will specify which fields are incorrect or missing.
    • Timeout or network errors suggest checking internet connection or API endpoint availability.

Links and References

Discussion