Ksaar

Overview

This node integrates with the Ksaar API, enabling users to interact programmatically with Ksaar's platform resources such as Users, Applications, Workflows, and Records. It supports a variety of operations including retrieving user details, listing applications, managing workflows, and creating or updating records.

Typical use cases include:

• Automating user data retrieval and management.
• Fetching application and workflow information for reporting or integration.
• Creating, updating, or deleting records within Ksaar workflows.
• Handling files associated with records (uploading, downloading, deleting).

For example, a user might automate fetching all workflows for a specific application or update record fields based on external triggers.

Properties

Name	Meaning
Send Headers	Boolean flag to indicate whether custom HTTP headers should be sent with the API requests.
Headers	Collection of custom HTTP headers to send if "Send Headers" is enabled. Each header has a name and value.

The node also supports many other properties depending on the selected Resource and Operation, such as:

• Resource: Selects the type of resource to operate on (Users, Applications, Workflows, Records).
• Operation: Defines the action to perform on the selected resource (e.g., Get user, Get applications, Create a record).
• Various identifiers and parameters like User ID, Application ID, Workflow ID, Record ID, User Email, pagination options (Return All, Results per Page, Page Number), sorting options, filters, and field values for record creation or updates.

Output

The node outputs JSON data representing the response from the Ksaar API corresponding to the requested operation. The structure varies by resource and operation but generally includes:

• For list operations: arrays of objects representing users, applications, workflows, or records.
• For get operations: single objects with detailed information about the requested entity.
• For create/update operations: confirmation and details of the created or updated record.
• For file operations: metadata or binary content related to files attached to records.

If binary data is involved (e.g., uploading or downloading files), the node handles it appropriately using n8n's binary data system.

Dependencies

• Requires an API key credential for authenticating with the Ksaar API.
• Uses the base URL https://api.ksaar.co/v1 for all requests.
• Relies on internal helper functions (KsaarRequest) to make HTTP calls.
• Supports searching for resources via search methods integrated into resource locators.

Troubleshooting

• Authentication errors: Ensure the API key credential is correctly configured and valid.
• Invalid IDs: Many parameters require UUID format; invalid IDs will cause validation errors.
• Pagination issues: When not returning all results, ensure page numbers and limits are set correctly.
• Missing required parameters: Operations often require specific IDs or emails; missing these will cause errors.
• File upload/download errors: Confirm that binary data is properly provided when updating files.
• Filtering records: Filters must match existing field names and values; incorrect filters may return empty results.

Common error messages typically relate to HTTP status codes returned by the Ksaar API, such as 400 (bad request), 401 (unauthorized), or 404 (not found). Reviewing the API documentation and verifying input parameters usually resolves these.

Links and References

• Ksaar API Documentation (assumed official docs)
• n8n documentation on Creating Custom Nodes
• n8n documentation on Handling Binary Data