Get Record(s) with Knack API on New Record Created (Instant) from SmartSuite API

Pipedream makes it easy to connect APIs for Knack, SmartSuite and 2,400+ other apps remarkably fast.

Trigger workflow on

New Record Created (Instant) from the SmartSuite API

Next, do this

Get Record(s) with the Knack API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a SmartSuite trigger and Knack action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Record Created (Instant) trigger
1. Connect your SmartSuite account
2. Configure Webhook renewal schedule
3. Select a Solution ID
Configure the Get Record(s) action
1. Connect your Knack account
2. Configure Object Key
3. Optional- Configure Record ID
4. Optional- Configure Sort Field
5. Optional- Select a Sort Order
6. Optional- Configure Filters
7. Optional- Select a Filter Type
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Record Created (Instant) on SmartSuite

Description:Emit new event when a new record is created

Version:0.0.2

Key:smartsuite-new-record-created-instant

View on GitHub

SmartSuite Overview#

The SmartSuite API offers a way to streamline work by automating tasks, managing data, and integrating with other services. Within Pipedream, you can leverage this API to create workflows that react to events in SmartSuite, manipulate data within SmartSuite, or synchronize data between SmartSuite and other apps. This could range from updating project statuses, to aggregating data for reports, to syncing contacts across platforms.

Trigger Code#

import common from "../common/base.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  ...common,
  key: "smartsuite-new-record-created-instant",
  name: "New Record Created (Instant)",
  description: "Emit new event when a new record is created",
  version: "0.0.2",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventType() {
      return "RECORD_CREATED";
    },
    getSummary({ record_event_data: data }) {
      return `New record created with ID: ${data.record_id}`;
    },
  },
  sampleEmit,
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
SmartSuite	`smartsuite`	`app`	This component uses the SmartSuite app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Webhook renewal schedule	`timer`	`$.interface.timer`	The SmartSuite API requires occasional renewal of webhooks. This runs in the background, so you should not need to modify this schedule.
Solution ID	`solutionId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

SmartSuite uses API keys for authentication. When you connect your SmartSuite account, Pipedream securely stores the keys so you can easily authenticate to SmartSuite APIs in both code and no-code steps.

About SmartSuite#

Work Management Platform built for businesses, designed for people, and loved by teams. Any company size or industry.

Action#

Get Record(s) on Knack

Description:Get one or more Records for a Knack object [(See docs here)](https://docs.knack.com/docs/retrieving-records)

Version:0.0.1

Key:knack-get-record

View on GitHub

Knack Overview#

The Knack API allows for robust interactions with your Knack database, enabling automation of data entry, retrieval, updates, and deletion. With Pipedream, you can leverage these capabilities to create seamless workflows that react to events in real-time, sync data across platforms, and enhance your database management without manual intervention. Think less about CRUD operations and more about the magic of connecting your Knack data to the digital tools ecosystem.

Action Code#

import base from "../common/base.mjs";
import { optionalRecordId as recordId } from "../common/props.mjs";

export default {
  ...base,
  key: "knack-get-record",
  name: "Get Record(s)",
  description:
    "Get one or more Records for a Knack object [(See docs here)](https://docs.knack.com/docs/retrieving-records)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    recordId,
    sortField: {
      type: "string",
      label: "Sort Field",
      optional: true,
      description: `The field key to sort the records by. Use in conjunction with \`Sort Order\`.
        \\
        Example value: \`field_1\`
        \\
        See [the Knack API docs](https://docs.knack.com/docs/sorting) for more information.`,
    },
    sortOrder: {
      type: "string",
      label: "Sort Order",
      optional: true,
      options: [
        {
          label: "Ascending",
          value: "asc",
        },
        {
          label: "Descending",
          value: "desc",
        },
      ],
      description: "The order to sort the records by, based on `Sort Field`.",
    },
    filters: {
      type: "string[]",
      label: "Filters",
      description: `One or more filters the returned records should match. Each filter should be a string representing a JSON object.
        \\
        Example value: \`{ "field": "field_1", "operator": "contains", "value": "my name" }\`
        \\
        See [the Knack API docs](https://docs.knack.com/docs/constructing-filters) for more information.`,
      optional: true,
    },
    filterType: {
      type: "string",
      label: "Filter Type",
      optional: true,
      options: [
        {
          label: "Match any filter",
          value: "or",
        },
        {
          label: "Match all filters",
          value: "and",
        },
      ],
      description: "If using multiple `Filters`, sets whether the returned records should match **any** or **all** filters specified.",
    },
  },
  methods: {
    ...base.methods,
    getBaseParams() {
      return {
        objectKey: this.objectKey,
        recordId: this.recordId,
      };
    },
    getQueryParams() {
      return {
        sortField: this.sortField,
        sortOrder: this.sortOrder,
        filters: this.filters,
        filterType: this.filterType,
      };
    },
  },
  async run({ $ }) {
    const response = await this.knack.getRecord(
      $,
      this.getBaseParams(),
      this.getQueryParams(),
    );

    $.export(
      "$summary",
      `Obtained ${
        response instanceof Array
          ? `${response.length} records`
          : "record"
      } successfully`,
    );

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Knack	`knack`	`app`	This component uses the Knack app.
Object Key	`objectKey`	`string`	The key of the object which this record belongs to. See the Knack API docs for more information.
Record ID	`recordId`	`string`	The ID of the record to retrieve. If not specified, all records for the specified object will be retrieved. See the Knack API docs for more information.
Sort Field	`sortField`	`string`	The field key to sort the records by. Use in conjunction with `Sort Order`. Example value: `field_1` See the Knack API docs for more information.
Sort Order	`sortOrder`	`string`	Select a value from the drop down menu:`{ "label": "Ascending", "value": "asc" }{ "label": "Descending", "value": "desc" }`
Filters	`filters`	`string[]`	One or more filters the returned records should match. Each filter should be a string representing a JSON object. Example value: `{ "field": "field_1", "operator": "contains", "value": "my name" }` See the Knack API docs for more information.
Filter Type	`filterType`	`string`	Select a value from the drop down menu:`{ "label": "Match any filter", "value": "or" }{ "label": "Match all filters", "value": "and" }`