HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node integrates with the HaloPSA API to create a new "Site" entity within the system. It is useful for automating the addition of site records, which represent physical or organizational locations associated with clients. Typical use cases include setting up new client sites in bulk, synchronizing site data from other systems, or dynamically creating sites as part of a larger workflow involving client management.

For example, a user might automate the creation of a new site when onboarding a client, specifying key details such as the site name, client ownership, contact emails, and location-specific settings.

Properties

Name Meaning
Site Name The name of the site (required).
Client ID Numeric ID of the client that owns this site (required).
Accounts BCC Email Address BCC email address used for accounts communications.
Accounts CC Email Address CC email address used for accounts communications.
Accounts Email Address Primary email address for accounts contact.
Accounts First Name First name of the accounts contact person.
Accounts ID System ID related to accounts.
Accounts Last Name Last name of the accounts contact person.
Colour Color code assigned to the site for identification or UI purposes.
Default Delivery Boolean indicating if this site is the default delivery location.
Default Stock Location Numeric ID representing the default stock location for this site.
Deliver By User ID of the delivery contact person.
Disclaimer Match String A string used to match disclaimers related to the site.
Email Domain Email domain associated with the site.
Email Subject Prefix Prefix text added to email subjects sent from this site.
Facilities Manager User ID of the facilities manager responsible for the site.
Geocoord 1 First geographic coordinate (e.g., latitude).
Geocoord 2 Second geographic coordinate (e.g., longitude).
In Use By User ID of the person currently using the site.
Inactive Boolean flag indicating whether the site is inactive.
Invoice Address Is Delivery Boolean indicating if invoice address matches delivery address.
Is Invoice Site Boolean indicating if this site is used for invoicing.
Is Stock Location Boolean indicating if this site serves as a stock location.
LDAP String LDAP connection string for directory services integration.
Message Group ID Numeric ID for message group notifications related to the site.
Notes Free-text notes about the site.
Phone Number Contact phone number for the site.
Phone Number Int Integer representation of the phone number.
Reference Number Numeric reference number for the site.
Regional Director User ID of the regional director overseeing the site.
Seriousness Level Numeric level indicating seriousness for incidents at the site.
Site Date Format Numeric code representing preferred date format.
Site Time Offset Time offset in hours for the site's timezone.
SLA ID Service Level Agreement ID associated with the site.
Stopped Numeric flag indicating if the site is stopped (0 = active, 1 = stopped).
Timezone Timezone string for the site (e.g., "America/New_York").
To Domain Domain name to redirect to for the site.

Output

The node outputs JSON data representing the newly created site record as returned by the HaloPSA API. This typically includes all the properties set during creation along with any additional metadata or identifiers assigned by the system.

If the API supports it, binary data output is not indicated for this operation; the output is purely JSON structured data describing the site.

Dependencies

  • Requires an active connection to the HaloPSA API.
  • Needs an API authentication token or API key credential configured in n8n to authorize requests.
  • The node relies on the internal router logic to dispatch the create request to the appropriate API endpoint for sites.

Troubleshooting

  • Missing Required Fields: Errors may occur if required fields like "Site Name" or "Client ID" are omitted. Ensure these are provided.
  • Invalid Client ID: Providing a non-existent or invalid client ID will cause the API to reject the request.
  • API Authentication Errors: If the API key or token is missing, expired, or incorrect, authentication errors will be returned.
  • Data Validation Errors: Some fields have specific formats (e.g., email addresses, numeric IDs). Invalid formats can cause failures.
  • Network Issues: Connectivity problems between n8n and the HaloPSA API will result in request timeouts or failures.

To resolve errors:

  • Double-check all required inputs.
  • Verify API credentials and permissions.
  • Validate field formats before execution.
  • Review API response messages for specific error details.

Links and References

Discussion