Knack

https://docs.knack.com
Admin
Knack is a no-code application development platform that enables users to build custom web...
Tokens:452,461
Snippets:4,760
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### Real-Time Validation Example

Source: https://docs.knack.com/reference/record-and-form-events

Complete example showing how to prevent duplicate product selection using field change events and view-level methods.

```APIDOC
## Example: Real-Time Validation

### Description
Prevents duplicate product selection in a form. When a user selects a product from a dropdown (field_110), the script checks an existing DataTable view (view_216) on the same page. If the product already exists, a warning message is shown and the submit button is disabled. If the product is new, the message is cleared and submission is re-enabled.

### Code
```javascript
Knack.ready().then(async () => {
  Knack.on('form:field-change:view_215', async ({ viewKey, fieldKey, value, formData }) => {

    if (fieldKey === 'field_110') { // Product dropdown

      // Retrieve current records from the table view on the same page
      const tableData = await Knack.view('view_216').getData();

      // Check if the selected product already exists
      const productExists = tableData.records.some(record =>
        record.field_110 === value
      );

      if (productExists) {
        // Show a warning near the field
        await Knack.view(viewKey).showFieldMessage('field_110', {
          type: 'warning',
          message: 'Product Already Added'
        });
        // Prevent form submission
        await Knack.view(viewKey).setSubmitEnabled(false);

      } else {
        // Clear the warning and allow submission
        await Knack.view(viewKey).clearFieldMessage('field_110');
        await Knack.view(viewKey).setSubmitEnabled(true);
      }
    }
  });
});
```
```

--------------------------------

### View-Based GET Response

Source: https://docs.knack.com/reference/retrieving-one-record

Example JSON response for a view-based record retrieval.

```json
{
  "id": "58643557d1ea9432222f3cb5",
  "field_1": "BASCO",
  "field_1_raw": "BASCO",
  "field_16": "4295 Drainer Avenue<br />Tallahassee, FL 32304",
  "field_16_raw": {
    "longitude": -84.177903,
    "latitude": 30.463511,
    "zip": "32304",
    "state": "FL",
    "city": "Tallahassee",
    "street2": "",
    "street": "4295 Drainer Avenue"
  },
  "field_18": "Entertainment",
  "field_18_raw": "Entertainment",
  "field_17": "<a href=\"http://www.basco.com\" target=\"_blank\">http://www.basco.com</a>",
  "field_17_raw": {
    "url": "http://www.basco.com"
  },
  "field_31": "850-644-1128",
  "field_31_raw": "850-644-1128"
}
```

--------------------------------

### Customer Onboarding Workflow Example

Source: https://docs.knack.com/reference/record-and-form-events

Shows how to trigger specific business logic, such as onboarding workflows, when an enterprise customer record is created in a specific view.

```javascript
// Example: Customer onboarding workflow
Knack.on('record:create', ({ record, viewKey }) => {
  if (viewKey === 'view_customer_form' && record.field_customer_type === 'Enterprise') {
    console.log('New enterprise customer created:', record.field_company_name);
    triggerEnterpriseOnboarding(record);
    assignEnterpriseAccountManager(record);
    sendEnterpriseWelcomeEmail(record.field_email);
  }
});
```

--------------------------------

### Retrieve User Data at Startup

Source: https://docs.knack.com/reference/schema-access-methods

Use this approach to fetch user data once during the initial application load.

```javascript
Knack.ready().then(() => {
  Knack.getUser().then(user => {
    // Runs only once when app loads
  })
})
```

--------------------------------

### Object-Based GET Response

Source: https://docs.knack.com/reference/retrieving-one-record

Example JSON response for an object-based record retrieval.

```json
{
  "id": "58643557d1ea9432222f3cbb",
  "field_1": "Pearl Architectural Design",
  "field_1_raw": "Pearl Architectural Design",
  "field_16": "4913 Gnatty Creek Road
Westbury, NY 11590",
  "field_16_raw": {
    "street": "4913 Gnatty Creek Road",
    "city": "Westbury",
    "state": "NY",
    "zip": "11590",
    "latitude": 40.89964,
    "longitude": -73.601586
  },
  "field_17": "<a href=\"http://www.pearlinc.com\" target=\"_blank\">http://www.pearlinc.com</a>",
  "field_17_raw": {
    "url": "http://www.pearlinc.com"
  },
  "field_18": "Services",
  "field_18_raw": "Services",
  "field_31": "516-334-3077",
  "field_31_raw": "516-334-3077"
}
```

--------------------------------

### getDateMonthOfYearName(DATE)

Source: https://docs.knack.com/docs/text-formula-functions

Gets the month of the year from a date field. For example, getDateMonthOfYearName({Date}) returns 'April'.

```APIDOC
## getDateMonthOfYearName(DATE)

### Description
Gets the month of the year from a date field.

### Function Signature
`getDateMonthOfYearName(DATE)`

### Parameters
- **DATE** (date field) - Required - The date field from which to extract the month of the year.

### Example
`getDateMonthOfYearName({Date}) = April`
```

--------------------------------

### Access Next-Gen User Information

Source: https://docs.knack.com/docs/user-tokens

Use Knack.ready() to ensure the app is initialized before retrieving user details or checking profile keys.

```JavaScript
Knack.ready().then(async () => {
  // Get current user information
  const user = await Knack.getUser();

  if (user) {
    console.log('Current user:', user);
    console.log('User email:', user.email);
    console.log('User name:', user.name);
  } else {
    console.log('No user is currently logged in');
  }

  // Check if the current user has a specific profile/role key
  try {
    const hasProfile = await Knack.hasProfileKey?.('profile_1'); // e.g., 'profile_1'
    if (typeof hasProfile === 'boolean') {
      console.log('Has profile_1?', hasProfile);
    }
  } catch (e) {
    // Swallow if not supported
  }
});
```

--------------------------------

### Knack.ready()

Source: https://docs.knack.com/reference/schema-access-methods

Initializes the Knack object and ensures the React application has finished mounting before executing custom code.

```APIDOC
## Knack.ready()

### Description
Initializes the Knack object and ensures the React application has finished mounting before executing custom code.

### Method
ready()

### Endpoint
Knack.ready()

### Parameters
None

### Request Example
```javascript
Knack.ready().then(async () => {
  // All your custom code goes here
  console.log('Knack is ready for customization!');
});
```

### Response
#### Success Response
- **Promise** - Resolves when the Knack object is fully initialized.

#### Response Example
```javascript
// No explicit response value; the promise resolves when ready.
```
```

--------------------------------

### getDateDayOfWeekName(DATE)

Source: https://docs.knack.com/docs/text-formula-functions

Gets the day of the week from a date field. For example, getDateDayOfWeekName({Date}) returns 'Friday'.

```APIDOC
## getDateDayOfWeekName(DATE)

### Description
Gets the day of the week from a date field.

### Function Signature
`getDateDayOfWeekName(DATE)`

### Parameters
- **DATE** (date field) - Required - The date field from which to extract the day of the week.

### Example
`getDateDayOfWeekName({Date}) = Friday`
```

--------------------------------

### Sample prompt for building a Knack app

Source: https://docs.knack.com/docs/mcp

A prompt to use after connecting the Knack MCP server. It asks the AI to create a data model with Projects, Tasks, and People tables, including fields and relationships, and to provide a summary.

```text
I need to build a project management application in Knack.

The app needs:
- A Projects table with fields for: project name, status (active/on hold/completed),
  start date, due date, and a description
- A Tasks table with fields for: task name, assignee (text), priority
  (high/medium/low), due date, completion checkbox, and notes
- A connection from Tasks to Projects so each task belongs to a project
- A People table for team members with: full name, email, role, and department

Please create this data model in my Knack application, using descriptive names
for all tables and fields. After creating the schema, give me a summary of
what was built.
```

--------------------------------

### Conditional Example: Date Difference Calculations

Source: https://docs.knack.com/docs/equations-overview

Calculates date differences while handling blank start or end dates.

```text
{End Date} > 0 & {Start Date} > 0 ? {End Date} - {Start Date} : {Start Date} > 0 ? currentTime() - {Start Date} : 0
```

--------------------------------

### Multiple Records Response

Source: https://docs.knack.com/docs/response-format

Example JSON response for a GET request returning multiple records, including pagination metadata.

```json
{
  "total_pages": 1,
  "current_page": 1,
  "total_records": 2,
  "records": [
    {
      "id": "58643557d1ea9432222f3cbb",
      "field_1": "Pearl Architectural Design",
      "field_1_raw": "Pearl Architectural Design",
      "field_17": "<a href=\"http://www.pearlinc.com\" target=\"_blank\">http://www.pearlinc.com</a>",
      "field_17_raw": {
        "url": "http://www.pearlinc.com"
      },
      "field_18": "Services",
      "field_18_raw": "Services",
      "field_31": "516-334-3077",
      "field_31_raw": "516-334-3077"
    },
    {
      "id": "58643556d1ea9432222f3ca6",
      "field_1": "Kelly and Cohen",
      "field_1_raw": "Kelly and Cohen",
      "field_17": "<a href=\"http://www.kellycohen.com\" target=\"_blank\">http://www.kellycohen.com</a>",
      "field_17_raw": {
        "url": "http://www.kellycohen.com"
      },
      "field_18": "Services",
      "field_18_raw": "Services",
      "field_31": "315-296-4146",
      "field_31_raw": "315-296-4146"
    }
  ]
}
```

--------------------------------

### Troubleshooting: Method Returns Undefined

Source: https://docs.knack.com/reference/constructing-view-urls-in-next-gen-apps

Example showing correct usage inside Knack.ready() to avoid undefined return from Knack.getBaseUrl().

```APIDOC
## Troubleshooting: Method Returns Undefined

### Description
Ensure Knack.getBaseUrl() is called inside Knack.ready() to avoid undefined return.

### Method
JavaScript function call

### Endpoint
Knack.getBaseUrl()

### Parameters
None

### Example
```javascript
// Correct
Knack.ready().then(async () => {
  const baseUrl = Knack.getBaseUrl();
});

// Wrong
const baseUrl = Knack.getBaseUrl(); // May be undefined
```
```

--------------------------------

### Single Record Response

Source: https://docs.knack.com/docs/response-format

Example JSON response for a successful GET, POST, or PUT request returning a single record.

```json
{
  "id": "58643557d1ea9432222f3cbb",
  "field_1": "Pearl Architectural Design",
  "field_1_raw": "Pearl Architectural Design",
  "field_17": "<a href=\"http://www.pearlinc.com\" target=\"_blank\">http://www.pearlinc.com</a>",
  "field_17_raw": {
    "url": "http://www.pearlinc.com"
  },
  "field_18": "Services",
  "field_18_raw": "Services",
  "field_31": "516-334-3077",
  "field_31_raw": "516-334-3077"
}
```

--------------------------------

### Identify Next-Gen App HTML Patterns

Source: https://docs.knack.com/reference/using-developer-tools-to-inspect-css-classes-and-ids

Examples of HTML structure using standard Knack naming conventions for navigation and page content.

```html
<!-- Navigation -->
<nav class="kn-main-nav">
  <button class="kn-main-nav-item">Home</button>
</nav>

<!-- Page Content -->
<main class="kn-page">
  <h1 class="kn-page-title">Page Title</h1>
  <section class="kn-page-section">
    <div class="kn-form-view" id="view_456">
      <!-- View content -->
    </div>
  </section>
</main>
```

--------------------------------

### Setup Custom File Input

Source: https://docs.knack.com/docs/fileimage-uploads

Use this snippet inside the Knack.ready() block to attach the file upload handler to a specific DOM element.

```javascript
// Add this inside the Knack.ready() block:
setupFileUpload('#my-file-input', 'field_123', 'object_456');
```

--------------------------------

### JSON Response for Multiple Records

Source: https://docs.knack.com/docs/retrieving-multiple-records

An abbreviated example of the JSON response returned by the GET request, showing record fields and raw data.

```json
{
  "total_pages": 1,
  "current_page": 1,
  "total_records": 15,
  "records": [
    {
      "id": "58643557d1ea9432222f3cb5",
      "field_1": "BASCO",
      "field_1_raw": "BASCO",
      "field_16": "4295 Drainer Avenue<br />Tallahassee, FL 32304",
      "field_16_raw": {
        "longitude": -84.177903,
        "latitude": 30.463511,
        "zip": "32304",
        "state": "FL",
        "city": "Tallahassee",
        "street2": "",
        "street": "4295 Drainer Avenue"
      },
      "field_17": "<a href=\"http://www.basco.com\" target=\"_blank\">http://www.basco.com</a>",
      "field_17_raw": {
        "url": "http://www.basco.com"
      },
      "field_18": "Entertainment",
      "field_18_raw": "Entertainment",
      "field_14_raw": [
        {
          "first": "Barbara",
          "last": "Waters"
        },
        {
          "first": "Josefa",
          "last": "Willems"
        }
      ],
      "field_14": "<a href=\"#58643557d1ea9432222f3cd1\"><span id=\"58643557d1ea9432222f3cd1\">Barbara Waters</span></a><br /><a href=\"#58643558d1ea9432222f3ce9\"><span id=\"58643558d1ea9432222f3ce9\">Josefa Willems</span></a>"
    },
    {
      "id": "58643557d1ea9432222f3cb1",
      "field_1": "Cavages",
      "field_1_raw": "Cavages",
      "field_16": "3885 Mount Street<br />Saginaw, MI 48607",
      "field_16_raw": {
        "street": "3885 Mount Street",
        "city": "Saginaw",
        "state": "MI",
        "zip": "48607",
        "latitude": 44.352592,
        "longitude": -84.419193
      },
      "field_17": "<a href=\"http://www.cavages.com\" target=\"_blank\">http://www.cavages.com</a>",
      "field_17_raw": {
        "url": "http://www.cavages.com"
      },
      "field_18": "Health Care",
      "field_18_raw": "Health Care",
      "field_14_raw": [
        {
          "first": "Daniel",
          "last": "Navarrete"
        },
        {
          "first": "Mark",
          "last": "Silverstein"
        }
      ],
      "field_14": "<a href=\"#58643557d1ea9432222f3ccc\"><span id=\"58643557d1ea9432222f3ccc\">Daniel Navarrete</span></a><br /><a href=\"#58643558d1ea9432222f3cd9\"><span id=\"58643558d1ea9432222f3cd9\">Mark Silverstein</span></a>"
    },
    ..........
```

--------------------------------

### Cycle through selected checkboxes in a table

Source: https://docs.knack.com/docs/javascript-jquery-examples

Iterates over all checked checkboxes in a specific table view. Inside the loop, you can add code to get the record id or row value. The example shows how to get the record id from the closest row's id attribute. Replace view_5 with your view key.

```JavaScript
// Cycle through selected checkboxes. Use this in any code that needs to get the checked IDs
$('#view_5 tbody input[type=checkbox]:checked').each(function() {
  // add code here to get record id or row value
  var id = $(this).closest('tr').attr('id'); // record id
});
```
Tokens:
Raw