Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Webhook → Get One Webhook

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve information about a specific webhook. The "Get One Webhook" operation fetches details of a single webhook by its unique identifier. This is useful in scenarios where you want to inspect or verify the configuration and status of a particular webhook within your Halo PSA environment.

Practical examples include:

  • Auditing webhook configurations before making changes.
  • Fetching webhook details to display or log them in an automation workflow.
  • Validating that a webhook exists and is correctly set up before triggering related processes.

Properties

Name Meaning
Id The unique identifier of the webhook to retrieve.
Includedetails Optional query parameter to specify whether to include detailed information in response.

Output

The node outputs JSON data representing the webhook's details as returned by the Halo PSA API. This typically includes properties such as the webhook's ID, URL, events it listens to, status, and other metadata.

If the request fails, the output JSON will contain an error field with the error message.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects credentials containing base URL, tenant identifier, client ID, and client secret to authorize requests.
  • No additional external dependencies beyond the Halo PSA API.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an incorrect webhook ID will result in an error from the API indicating the webhook was not found.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "No credentials returned!": Indicates that the node could not find or access the required API credentials. Ensure credentials are configured properly.
    • Errors returned from the API (e.g., webhook not found) will be included in the output JSON under the error property if "Continue On Fail" is enabled.

  • Resolution tips:

    • Verify that the API credentials are correctly set up and have sufficient permissions.
    • Double-check the webhook ID input for correctness.
    • Enable "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion