Knack icon

Knack

Interact with Knack API

Actions2

Overview

This node integrates with the Knack API to manage records within Knack objects. It supports two main operations on records: retrieving a single record by its ID and searching for multiple records using filters and sorting options.

Typical use cases include:

  • Fetching detailed information about a specific record in a Knack database.
  • Querying records that meet certain criteria, such as filtering by field values or sorting results.
  • Automating workflows that require data retrieval from Knack without manual intervention.

For example, you could use this node to automatically pull customer details by their record ID or to search for all orders placed within a specific date range.

Properties

Name Meaning
Object Select the Knack object to operate on. This is the target data collection (e.g., "Customers", "Orders").

Note: Since the Resource is "Record" and Operation is "Default" (which maps to "Get" or "Search" internally), the only required property here is the "Object" selection.

Output

The node outputs JSON data representing the retrieved or searched records from the selected Knack object.

  • For Get operation: Outputs a single record's fields as key-value pairs, including an id field.
  • For Search operation: Outputs multiple records, each as a separate item with fields mapped similarly.

Field keys are mapped to their human-readable labels when possible. Optionally, the original field keys can be included alongside the mapped names if the user enables that option.

No binary data output is produced by this node.

Example output structure for a record:

{
  "id": "record_id",
  "Field Label 1": "value1",
  "Field Label 2": "value2",
  "Field Label 1_raw": "field_1_key"  // Only if "Include Field Keys" option enabled
}

Dependencies

  • Requires an API key credential for authenticating with the Knack API.
  • Needs access to 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

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect object key or record ID may result in "not found" errors.
    • Network connectivity problems can prevent API calls from succeeding.
    • Using unsupported filter operators or invalid filter formats may cause errors during search.

  • Error messages:

    • Errors returned from the Knack API are propagated and wrapped as node operation errors.
    • If "Continue On Fail" is enabled, errors for individual items are returned as JSON with an error field instead of stopping execution.

  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check object keys and record IDs.
    • Ensure filters and parameters conform to Knack API specifications.
    • Enable "Continue On Fail" to handle partial failures gracefully.

Links and References

Discussion