Ksaar icon

Ksaar

Consume Ksaar API

Actions13

Overview

This node integrates with the Ksaar API to interact with workflows and their related data. Specifically, for the Workflows resource and the Get Fields operation, it retrieves the metadata fields associated with a specified workflow within an application.

Typical use cases include:

  • Fetching the list of fields defined in a workflow to dynamically build forms or validate input data.
  • Automating processes that depend on workflow structure by programmatically accessing field definitions.
  • Integrating with other systems where knowledge of workflow fields is necessary for data mapping or synchronization.

For example, you might use this node to get all fields of a workflow before creating or updating records in that workflow, ensuring that your data matches the expected schema.

Properties

Name Meaning
Send Headers Boolean flag to indicate whether custom HTTP headers should be sent with the API request.
Headers Collection of custom HTTP headers (name-value pairs) to include if "Send Headers" is enabled.
Application The target application containing the workflow. Can be selected from a list or specified by ID.
Workflow The specific workflow whose fields are to be retrieved. Can be selected from a list or by ID.

Output

The output is a JSON array where each item represents a field definition of the specified workflow. Each field object typically contains metadata such as field name, type, identifier, and possibly other attributes describing the field's properties.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Ksaar API via an API key credential configured in n8n.
  • The node uses internal helper functions to perform authenticated HTTP requests to Ksaar's REST endpoints.
  • The user must have access rights to the specified application and workflow within Ksaar.

Troubleshooting

  • Invalid IDs: If the provided Application or Workflow ID does not match the expected UUID format, the node will reject the input. Ensure IDs conform to the pattern [a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}.
  • Authorization Errors: If the API key credential is missing, invalid, or lacks permissions, the node will fail to retrieve fields. Verify API credentials and permissions.
  • Empty Results: If no fields are returned, confirm that the workflow exists and has fields defined.
  • Network Issues: Connectivity problems to https://api.ksaar.co/v1 will cause request failures. Check network access and proxy settings if applicable.

Links and References

Discussion