Skip to main content

Knack

Getting Started with Knack

Prerequisites

  • A Knack account

In order to use Knack with Make, it is necessary to have a Knack account. If you do not have one, you can create a Knack account at www.knack.com.

Connect Knack to Make

To connect Knack app, you need to obtain the Application ID and API Key from your Knack account and insert them into your Make scenario.

  1. Log in to your Knack account. 1. Find the Knackin the Settings >dialog.

  2. Click on the available App.

    Knack_1.png

  3. Click Settings > API & Code . Copy the Application ID and API key to a safe place.

    Knack_2.png

  4. In your Make account, insert a Knack module in your scenario and click the Add button next to the Connection field.

  5. In the Connection name field, enter a name for the connection.

  6. In the Application ID and API Key fields, enter the details copied in step 3. In the Private API server domain field, enter the private Knack server domain if needed and click Save.

    Knack_3.png

You have successfully established the connection. You can now begin editing your scenario and adding more Knack modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.

Private API server domain

Enter the private Knack server domain if needed.

Triggers

New Event

This module is triggered when a new record is created, updated, or deleted.

61d6a42071c55.png

Webhook name

Enter the name for the webhook.

Connection

Establish a connection to your Knack account.

Object

Select the object you want to watch.

Event

Select the event that triggers the module.

Note

The trigger Knack > New event triggers only when records are created/updated/deleted in your Knack app, not in the Knack builder.

If the URL in your web browser starts with https://builder.knack.com/ then you are using the Knack builder, not your Knack app.

To enter your Knack app, click on the "view live app" button in the top right corner:

mceclip0-26.png

Links to update and/or edit the record must be created.

To create the links, follow the Using Actions Links guide.

61d6a421a3ad7.gif

Watch Records

Retrieves data for a record.

Connection

Establish a connection to your Knack account.

Object

Select the object you want to watch.

Auto increment field

Select the Auto Increment field.

Every object that you want Make to watch must have at least one field of Auto Increment type. The Auto Increment field contains a sequence number assigned to the record. The value for the first record is 1, and it increments by 1 for each new record.

Warning

Make will not correctly import records that do not include this field.

61d6a4242b5c2.gif

The option Since specific ID in the Choose where to start dialog must contain the Auto Increment value, e.g. 1. Do not use the Record ID!

61d6a4266b8b9.png

Limit

The maximum number of records Make will work with during one execution cycle.

Returned data

Select the format type of the returned data.

formatted and raw

The returned data is formatted and raw:

form_raw.png

only formatted

The returned data is formatted into one line:

formatted.png

only raw

The data is returned in the raw format, as an object:

raw.png

Actions

Create a Record

Creates a new record.

Make allows the adding of records to all types of object fields, except for these types: Timer and Signature.

Connection

Establish a connection to your Knack account.

Object

Select the object where you want to create the record.

Field names

Enter the values you want to add to the new record.

Delete a Record

Deletes a record.

Connection

Establish a connection to your Knack account.

Object

Select the object you want to delete.

Record ID

Enter the ID of the record you want to delete. It can be retrieved, for example, using the Search for Records module.

Get a Record

Retrieves a record's details.

Connection

Establish a connection to your Knack account.

Object

Select the object that contains the desired record.

Record ID

Enter the record ID. It can be retrieved, for example, using the Search for Records module.

61d6a4298f86d.png

Returned data

Select the format type of the returned data.

formatted and raw

The returned data is formatted and raw:

form_raw.png

only formatted

The returned data is formatted into one line:

formatted.png

only raw

The data is returned in raw format, as an object:

raw.png

Update a Record

Updates a desired record.

Connection

Establish a connection to your Knack account.

Object

Select the object that contains the record you want to update.

Record ID

Enter the ID of the record you want to update. The ID can be retrieved, for example, using the Search for Records module.

Field names

Enter the desired value to the field(s) you want to update.

61d6a42757581.png

Upload a File

Uploads a mapped file.

Connection

Establish a connection to your Knack account.

File name

Enter or map the file name.

Data

Enter (map) the file data. You can use, for example, the Dropbox > Get a file module.

61d6a428615f6.png

Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your Knack account.

URL

Enter a path relative to https://api.knack.com (or custom domain). For example, /v1/objects.

Method

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of use - Search Tasks

The following API call returns all tasks from your account.

URL: /v1/objects

Method: GET

Matches of the search can be found in the module's Output under Bundle > Body > objects.

Knack_4.png

In our example, 3 objects were returned:

Knack_5.png

Searches

Search for Records

This module retrieves information about records. The result can be filtered.

Connection

Establish a connection to your ActiveCampaign account.

Object

Select the object with the records you want to retrieve.

Filter

Specify the filter settings.

E.g. The following example returns a record where the name is John and the amount is higher than 100.

61d6a42a82756.png

Sort field

Select the field you want to sort the result by.

Sort order

Select the sort order.

ASC - ascending.

DESC - descending.

Limit

Set the maximum number of records Make will return during one execution cycle.

Returned data

Select the format type of the returned data.

formatted and raw

The returned data is formatted and raw:

form_raw.png

only formatted

The returned data is formatted into one line:

formatted.png

only raw

The data is returned in raw format, as an object:

raw.png
61d6a42b74af3.png

Private Knack Servers

Make will make connections to your database from its IP addresses. Ensure you whitelist the IP addresses to allow conections to your Knack servers.

See also

In this section: