Create Customer with Customer Fields API on New Record from Knack API

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

Trigger workflow on

New Record from the Knack API

Next, do this

Create Customer with the Customer Fields 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 Knack trigger and Customer Fields 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 trigger
1. Connect your Knack account
2. Configure Object Key
3. Configure timer
Configure the Create Customer action
1. Connect your Customer Fields account
2. Optional- Select a Form ID
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 on Knack

Description:Emit new event for each record created

Version:0.0.2

Key:knack-new-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.

Trigger Code#

import knack from "../../knack.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "knack-new-record",
  name: "New Record",
  description: "Emit new event for each record created",
  type: "source",
  version: "0.0.2",
  dedupe: "unique",
  props: {
    knack,
    objectKey: {
      type: "string",
      label: "Object Key",
      description: "The key of the object which this record belongs to. See [the Knack API docs](https://docs.knack.com/docs/object-based-requests) for more information.",
    },
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run({ $ }) {
    const records = await this.knack.getAllRecords($, {
      objectKey: this.objectKey,
    }, {
      rows_per_page: 100,
    }, true);

    for (const record of records) {
      this.$emit(record, {
        id: record.id,
        summary: `New record ${record.id}`,
        ts: new Date(),
      });
    }
  },
};

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
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.
	`timer`	`$.interface.timer`

Trigger Authentication#

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

Object-based requests require at least two headers: an application ID - to identify to our servers the app whose records you are requesting - and an API key (which is specific to each app) to authenticate the request. See docs.

About Knack#

Business app platform

Action#

Create Customer on Customer Fields

Description:Create a new customer with detailed attributes using the provided data. [See the documentation](https://docs.customerfields.com/#8a70d5ee-da8f-4ef0-8b08-9c1882b4da04).

Version:0.0.1

Key:customer_fields-create-customer

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.

Action Code#

/* eslint-disable no-unused-vars */
import common from "../common/customer.mjs";

export default {
  ...common,
  key: "customer_fields-create-customer",
  name: "Create Customer",
  description: "Create a new customer with detailed attributes using the provided data. [See the documentation](https://docs.customerfields.com/#8a70d5ee-da8f-4ef0-8b08-9c1882b4da04).",
  type: "action",
  version: "0.0.1",
  methods: {
    ...common.methods,
    createCustomer(args = {}) {
      return this.app.post({
        path: "/customers",
        ...args,
      });
    },
  },
  async additionalProps() {
    const { data_columns: dataColumns } =
      await this.app.listDataColumns({
        params: {
          ignore_read_only: true,
          form_id: this.formId,
        },
      });
    return this.getPropsFromDataColumns({
      dataColumns,
    });
  },
  async run({ $: step }) {
    const {
      app,
      createCustomer,
      getDataFromDataColumns,
      formId,
      ...dataColumns
    } = this;

    const response =
      await createCustomer({
        step,
        data: getDataFromDataColumns(dataColumns),
      });

    step.export("$summary", `Successfully created customer with ID ${response?.customer?.id}.`);

    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
Customer Fields	`app`	`app`	This component uses the Customer Fields app.
Form ID	`formId`	`string`	Select a value from the drop down menu.

Action 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