Knack icon

Knack

Interact with Knack API
Join our community

Actions6

Overview

This node interacts with the Knack API to manage records within Knack objects. Specifically, the "Record - Get" operation retrieves a single record by its ID from a specified Knack object.

Common scenarios where this node is beneficial include:

  • Fetching detailed information about a specific record in a Knack database for further processing or integration.
  • Retrieving data to validate or enrich workflows based on existing records.
  • Accessing record details dynamically during automation processes.

Practical example:

  • You have a customer management app in Knack and want to retrieve a customer's record by their unique ID to send a personalized email or update another system.

Properties

Name Meaning
Object Select the Knack object to operate on (e.g., Customers, Orders). The list is dynamically loaded from your Knack application.
Record ID The unique identifier of the record you want to retrieve from the selected object.
Additional Options Collection of optional settings:
  Include Field Keys Boolean option to duplicate field values with a "_raw" suffix (e.g., "Name": "John", "Name_raw": "John"). Defaults to true.

Output

The output JSON contains the retrieved record's fields mapped with user-friendly keys. If "Include Field Keys" is enabled, each field value is duplicated with a _raw suffix containing the raw data.

Example output structure:

{
  "id": "record_id",
  "Field Label 1": "Value 1",
  "Field Label 1_raw": "Value 1",
  "Field Label 2": "Value 2",
  "Field Label 2_raw": "Value 2",
  ...
}
  • id: The record's unique identifier.
  • Other keys correspond to the field labels from the Knack object, providing easy access to field values.
  • The _raw suffixed fields contain the original raw values if enabled.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Knack API.
  • Needs the Knack Application ID and REST API Key configured in the credentials.
  • The node makes HTTP requests to the Knack API endpoint (default: https://api.knack.com/v1).

Troubleshooting

  • Missing or invalid credentials: Ensure that the API key and application ID are correctly set up in the node credentials.
  • Invalid Record ID: If the provided record ID does not exist or is malformed, the API will return an error. Verify the record ID format and existence.
  • Object selection issues: The object must be selected from the dropdown populated by the node. If no objects appear, check the API credentials and network connectivity.
  • API rate limits or downtime: The Knack API may throttle requests or be temporarily unavailable. Retry after some time or check Knack service status.
  • Field key duplication disabled: If you rely on raw field values but "Include Field Keys" is set to false, raw data won't be available in output.

Common error messages:

  • "Record not found": The record ID does not exist in the selected object.
  • "Unauthorized" or "Invalid API key": Credentials are incorrect or expired.
  • "Failed to fetch field metadata": Network or permission issues when retrieving object schema.

Links and References

Discussion