Actions68
- Client Actions
- Agent Actions
- Asset Actions
- Field Info Actions
- Invoice Actions
- Site Actions
- Ticket Actions
- Ticket Status Actions
- Ticket Type Actions
- Timesheet Actions
- Timesheet Event Actions
- Webhook Actions
- Webhook Event Actions
Overview
This node allows you to execute a specific webhook or runbook by its unique identifier (UUID) within the HaloPSA system. It is useful for triggering automated workflows or processes defined as webhooks/runbooks remotely from your n8n workflow. Common scenarios include initiating incident response procedures, starting approval chains, or running custom automation scripts in HaloPSA based on events or data processed in n8n.
For example, you might use this node to:
- Trigger a runbook that creates a support ticket when a new customer inquiry arrives.
- Execute a webhook that updates asset information after an inventory scan.
- Run a test mode execution of a webhook to validate configurations without affecting live data.
Properties
| Name | Meaning |
|---|---|
| Webhook ID | The UUID of the webhook or runbook to execute. This uniquely identifies which webhook to run. |
| Test Mode | Boolean flag indicating whether to run the webhook in test mode (true) or live mode (false). |
| Additional Options | Collection of extra options: |
| - Custom Parameters | JSON object with additional parameters to pass to the webhook execution. |
Output
The node outputs the result of executing the specified webhook/runbook. The output is provided in the json field and typically contains the response data returned by the webhook execution endpoint. This may include status information, execution results, or any data returned by the runbook.
If the webhook produces binary data, it would be included accordingly, but based on the code and context, the primary output is JSON-formatted execution results.
Dependencies
- Requires an API key credential for authenticating with the HaloPSA API.
- Needs network access to the HaloPSA service endpoints.
- No other external dependencies are indicated in the source code.
Troubleshooting
- Invalid Webhook ID: If the provided UUID does not correspond to an existing webhook/runbook, the node will likely return an error. Verify the UUID is correct.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to execute webhooks.
- Test Mode Behavior: Running in test mode may produce different results than live execution; verify if test mode is appropriate for your use case.
- Malformed Custom Parameters: The
customParametersmust be valid JSON. Invalid JSON will cause errors during execution. - Network Issues: Connectivity problems to the HaloPSA API will prevent execution.
Links and References
- HaloPSA Official Documentation (for webhook and runbook details)
- n8n Documentation (for general node usage and credentials setup)