HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node allows users to create webhooks within the HaloPSA system. Webhooks are HTTP callbacks that send data to external URLs or trigger internal automation runbooks when specific events occur. This node is useful for integrating HaloPSA with other systems by automatically sending event data or triggering workflows.

Common scenarios include:

  • Sending ticket updates or client changes to an external CRM or notification system.
  • Triggering internal automation runbooks based on webhook events.
  • Configuring secure and customizable webhook endpoints with authentication and batching options.

For example, a user can create an outbound webhook that sends JSON payloads via POST to a specified URL whenever a ticket is updated, optionally using basic authentication and batching requests every 30 seconds.

Properties

Name Meaning
Name The name of the webhook.
Additional Fields A collection of optional settings to customize the webhook behavior:
- Active Whether the webhook is active (true/false).
- Authentication Type Method of authentication for the webhook. Options: None, Basic Auth, Bearer Token, API Key, Certificate.
- Auto Disable Attempts Number of consecutive failures before the webhook auto-disables. 0 means never auto-disable.
- Basic Username Username for basic authentication (shown if Basic Auth selected).
- Basic Password Password for basic authentication (shown if Basic Auth selected).
- Batch Delay Seconds Delay in seconds before sending batched webhook executions. Minimum 1 second.
- Batch Limit Maximum number of items per batch. 0 means unlimited.
- Batch Method How to batch webhook executions. Options: None, Time Based, Count Based.
- Content Type Content type header for webhook payloads, e.g., "application/json".
- Custom Payload Whether to use a custom payload format (true/false).
- HTTP Method HTTP method used for the webhook request. Options: POST, GET, PUT, DELETE, PATCH.
- Infinite Loop Threshold Maximum number of recursive executions allowed to prevent infinite loops. Minimum 1.
- Log Retention Policy Days Number of days to retain webhook execution logs. Range: 1 to 365.
- Note Description or notes about the webhook (up to 4000 characters).
- Notify on Failure Whether to send notifications when the webhook fails (true/false).
- Payload Type Type of payload sent. Options: Default, Custom JSON, Runbook Variables.
- Type Type of webhook. Options: Outbound Webhook (sends data to external URLs), Runbook (triggers internal automation).
- URL The destination URL for outbound webhooks (required if Type is Outbound Webhook).

Output

The node outputs JSON data representing the result of the webhook creation operation. This typically includes details about the created webhook such as its ID, status, configuration, and any relevant metadata returned by the HaloPSA API.

If the webhook involves binary data (not indicated here), it would be included in the output accordingly, but this node primarily deals with JSON payloads describing webhook configurations.

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 external services are required beyond the HaloPSA platform.
  • Proper network access to the target webhook URL is necessary for outbound webhooks.

Troubleshooting

  • Invalid Authentication Settings: If authentication credentials (e.g., basic username/password) are incorrect or missing, webhook creation may fail. Verify credentials and authentication type.
  • Missing Required Fields: The webhook name and URL (for outbound webhooks) are mandatory. Ensure these are provided.
  • API Connectivity Issues: Network problems or incorrect API credentials can cause errors. Check API key validity and network connectivity.
  • Batch Configuration Errors: Setting batch delay or limits incorrectly (e.g., zero or negative values) may cause unexpected behavior. Use valid positive numbers.
  • Infinite Loop Prevention: If the infinite loop threshold is too low, legitimate recursive calls might be blocked. Adjust threshold as needed.
  • Webhook Disabled Automatically: If the webhook experiences consecutive failures exceeding the auto-disable attempts, it will be disabled. Monitor webhook health and fix endpoint issues.

Common error messages usually relate to authentication failure, invalid parameters, or API request timeouts. Reviewing the webhook configuration and API logs helps resolve these.

Links and References

Discussion