Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Bookmark → Post Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Bookmark resource with the Post Undefined operation, it allows creating or updating bookmark entries by sending relevant data fields to the API.

Typical use cases include automating the management of bookmarks related to entities such as tickets, clients, or agents within the Halo PSA system. For example, you might use this node to programmatically add a bookmark to a ticket or mark an entity as bookmarked based on workflow conditions.

Properties

Name Meaning
Id Numeric identifier of the bookmark entry.
Entity Id Numeric identifier of the entity being bookmarked (e.g., ticket ID, client ID).
Entity Type Numeric code representing the type of entity being bookmarked.
Agent Id Numeric identifier of the agent associated with the bookmark.
Bookmarked Boolean flag indicating whether the entity is bookmarked (true) or not (false).

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the Halo PSA API for the bookmark creation or update request. The structure typically reflects the created or updated bookmark resource as returned by the API.

If an error occurs during processing and the node is configured to continue on failure, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including:
    • Base URL of the Halo PSA instance.
    • Tenant identifier.
    • Client ID and Client Secret for authentication.
  • The node uses these credentials to authenticate API requests via custom headers.
  • No additional external dependencies are required beyond the n8n environment and the provided credentials.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause the node to throw an error "No credentials returned!".
    • Incorrect or missing required properties (like id, entity_id, etc.) may result in API errors.
    • Network connectivity issues or incorrect base URL can lead to request failures.

  • Error messages:

    • Errors returned from the API are passed through in the output JSON under the error key if "Continue On Fail" is enabled.
    • If the specified resource or operation is not found, the node throws errors like "Resource Bookmark not found" or "Operation Post Undefined not found for resource Bookmark".

  • Resolution tips:

    • Ensure all required properties are correctly set and valid.
    • Verify that the API credentials are correct and have sufficient permissions.
    • Check network connectivity and the correctness of the base URL.
    • Use the "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion