Create Record with Knack API on Customer Created (Instant) from Customer Fields API

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

Trigger workflow on

Customer Created (Instant) from the Customer Fields API

Next, do this

Create Record 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 Customer Fields 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 Customer Created (Instant) trigger
1. Connect your Customer Fields account
Configure the Create Record action
1. Connect your Knack account
2. Configure Object Key
3. Configure Record Data
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#

Customer Created (Instant) on Customer Fields

Description:Trigger when a new customer is added to the database. [See the documentation](https://docs.customerfields.com/#0824dffa-8d67-4b90-828b-289f7fd46899).

Version:0.0.1

Key:customer_fields-customer-created

View on GitHub

Customer Fields Overview#

The Customer Fields API provides a suite of tools for managing customer data in e-commerce platforms, including custom form fields and data automation. With it, you can efficiently tailor customer interactions, streamline data collection, and enhance the shopping experience. Integrating Customer Fields with Pipedream allows for seamless automation of tasks like syncing data to other platforms, triggering personalized communications, or managing customer segments based on custom field data.

Trigger Code#

import common from "../common/webhook.mjs";
import topics from "../common/topics.mjs";

export default {
  ...common,
  key: "customer_fields-customer-created",
  name: "Customer Created (Instant)",
  description: "Trigger when a new customer is added to the database. [See the documentation](https://docs.customerfields.com/#0824dffa-8d67-4b90-828b-289f7fd46899).",
  type: "source",
  version: "0.0.1",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getResourcesFn() {
      return this.app.listCustomers;
    },
    getResourcesFnArgs() {
      return {
        params: {
          sort_by: "created_at",
          sort_order: "desc",
        },
      };
    },
    getResourcesName() {
      return "customers";
    },
    getTopicName() {
      return topics.CUSTOMERS_CREATE;
    },
    generateMeta(resource) {
      return {
        id: resource.id,
        summary: `New Customer: ${resource.id}`,
        ts: Date.parse(resource.created_at),
      };
    },
  },
};

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
Customer Fields	`app`	`app`	This component uses the Customer Fields 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.

Trigger Authentication#

Customer Fields uses OAuth authentication. When you connect your Customer Fields account, Pipedream will open a popup window where you can sign into Customer Fields and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Customer Fields API.

Pipedream requests the following authorization scopes when you connect your account:

readwrite

About Customer Fields#

Create customer sign-up forms as unique as your business, and save custom data to customer accounts.

Action#

Create Record on Knack

Description:Create a Record for a Knack object [(See docs here)](https://docs.knack.com/docs/object-based-post)

Version:0.0.1

Key:knack-create-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 { recordData } from "../common/props.mjs";

export default {
  ...base,
  key: "knack-create-record",
  name: "Create Record",
  description:
    "Create a Record for a Knack object [(See docs here)](https://docs.knack.com/docs/object-based-post)",
  version: "0.0.1",
  type: "action",
  props: {
    ...base.props,
    recordData,
  },
  methods: {
    getBaseParams() {
      return {
        objectKey: this.objectKey,
        data: this.recordData,
      };
    },
  },
  async run({ $ }) {
    const response = await this.knack.createRecord($, this.getBaseParams());

    $.export("$summary", "Created 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 Data	`recordData`	`object`	The record fields to be updated and their new values. See the Knack API docs for more information.