Ksaar icon

Ksaar

Consume Ksaar API

Actions13

Overview

This node integrates with the Ksaar API to manage records within workflows. Specifically, the "Create a Record" operation allows users to create a new record in a specified workflow by providing user email and field values. This is useful for automating data entry into Ksaar workflows, such as submitting form responses or logging user activity.

Practical examples:

  • Automatically creating a new customer record when a form is submitted.
  • Logging user actions or events into a workflow for tracking purposes.
  • Populating workflow records with data collected from other systems.

Properties

Name Meaning
Send Headers Whether to send custom HTTP headers with the request (true/false).
Headers Custom HTTP headers to include if "Send Headers" is enabled; specify header name and value.
Application The application context under which the workflow operates; select an application or provide its ID. (Required)
Workflow The workflow where the record will be created; select a workflow or provide its ID. (Required)
User The user associated with the record; select a user or provide their email address. (Required)
Fields Key-value pairs representing fields and their values to set in the new record. Each field requires selecting a field and specifying its value.

Output

The output is a JSON array containing the newly created record's data as returned by the Ksaar API. The structure includes at least the record details corresponding to the provided fields and metadata about the record creation.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Ksaar API.
  • The node makes HTTP requests to https://api.ksaar.co/v1.
  • Uses internal helper functions to perform authenticated API calls.
  • Requires proper configuration of resource locators for Application, Workflow, User, and Fields to resolve IDs.

Troubleshooting

  • Invalid IDs or Emails: The node validates UUID formats for IDs and email format for user email. Errors occur if these are invalid. Ensure correct formatting.
  • Missing Required Parameters: Application, Workflow, User, and Fields are required. Omitting any will cause errors.
  • API Authentication Errors: If the API key is missing or invalid, requests will fail. Verify credentials.
  • Field Value Mismatch: Providing incorrect field IDs or incompatible values may cause API errors. Confirm field existence and expected value types.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the Ksaar API endpoint.

Links and References

Discussion