HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node allows updating an existing webhook configuration in the HaloPSA system. It is useful for managing webhook settings dynamically, such as changing the target URL, authentication method, or payload format without recreating the webhook from scratch.

Common scenarios include:

  • Modifying the destination URL of a webhook after deployment.
  • Changing authentication credentials or methods to secure webhook calls.
  • Adjusting batching behavior or payload types to optimize data delivery.
  • Enabling or disabling webhooks based on operational needs.

For example, you might update a webhook to switch from basic authentication to bearer token authentication or increase the batch delay to reduce load on the receiving server.

Properties

Name Meaning
Webhook ID The UUID of the webhook to update (required).
Update Fields A collection of fields to update on the webhook:
- Active Whether the webhook is active (true/false).
- Authentication Type Authentication method for the webhook. Options: None, Basic Auth, Bearer Token, API Key, Certificate.
- Auto Disable Attempts Number of consecutive failures before auto-disabling the webhook (0 means never auto-disable).
- Basic Password Password for basic authentication (shown only if Basic Auth is selected).
- Basic Username Username for basic authentication (shown only if Basic Auth is selected).
- Batch Delay Seconds Delay in seconds for batch processing of 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 for webhook payloads (e.g., "application/json").
- Custom Payload Whether to use a custom payload format (true/false).
- HTTP Method HTTP method to use for the webhook call. 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 (between 1 and 365).
- Name The name of the webhook.
- Note Description or notes for this webhook (up to 4000 characters).
- Notify on Failure Whether to send notifications when the webhook fails (true/false).
- Payload Type Type of payload to send. Options: Default, Custom JSON, Runbook Variables.
- Type The type of webhook. Options: Outbound Webhook (sends data to external URLs), Runbook (internal automation runbook).
- URL The URL to send webhook payloads to (required for outbound webhooks).

Output

The node outputs the result of the webhook update operation in the json output field. This typically includes details about the updated webhook such as its ID, status, and updated properties.

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

Dependencies

  • Requires an API key credential to authenticate 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 credential.

Troubleshooting

  • Invalid Webhook ID: If the provided webhook UUID does not exist, the API will likely return an error. Verify the webhook ID is correct.
  • Authentication Errors: Ensure the API key credential used has sufficient permissions to update webhooks.
  • Validation Errors: Some fields have constraints (e.g., minimum values, required fields like URL for outbound webhooks). Make sure all required fields are correctly set.
  • Network Issues: Connectivity problems with the HaloPSA API endpoint can cause failures.
  • Infinite Loop Threshold Misconfiguration: Setting this too low may prematurely stop webhook executions; setting it too high may risk runaway executions.

Links and References

Discussion