Create Contact with BenchmarkONE API on New Form Data Created from Kizeo Forms API

Pipedream makes it easy to connect APIs for BenchmarkONE, Kizeo Forms and 2,700+ other apps remarkably fast.

Trigger workflow on

New Form Data Created from the Kizeo Forms API

Next, do this

Create Contact with the BenchmarkONE 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 Kizeo Forms trigger and BenchmarkONE action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Form Data Created trigger
1. Connect your Kizeo Forms account
2. Configure Polling schedule
3. Select a Form ID
4. Select a Action
Configure the Create Contact action
1. Connect your BenchmarkONE account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Optional- Configure Title
5. Optional- Configure Company
6. Optional- Configure Work Email Address
7. Optional- Configure Home Email Address
8. Optional- Configure Work Phone
9. Optional- Configure Home Phone
10. Optional- Configure Work Address
11. Optional- Configure Home Address
12. Select a Status
13. Optional- Select a Temperature
14. Optional- Configure Website
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 Form Data Created on Kizeo Forms

Description:Emit new event each time new form data is created in Kizeo Forms. [See the documentation](https://kizeo.github.io/kizeo-forms-documentations/docs/en/restv3)

Version:0.0.1

Key:kizeo_forms-new-form-data

View on GitHub

Kizeo Forms Overview#

Kizeo Forms API lets you interact with the Kizeo platform to automate form data retrieval, manage users, and push or pull data to or from forms. On Pipedream, you can harness this API to create serverless workflows that trigger actions based on form submissions, integrate with other apps, or manage form data effectively. Use the API to connect Kizeo Forms with CRMs, project management tools, databases, and more, streamlining data collection and processing activities.

Trigger Code#

import common from "../common/polling.mjs";

export default {
  ...common,
  key: "kizeo_forms-new-form-data",
  name: "New Form Data Created",
  description: "Emit new event each time new form data is created in Kizeo Forms. [See the documentation](https://kizeo.github.io/kizeo-forms-documentations/docs/en/restv3)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    formId: {
      propDefinition: [
        common.props.app,
        "formId",
      ],
    },
    action: {
      propDefinition: [
        common.props.app,
        "action",
      ],
    },
  },
  methods: {
    ...common.methods,
    sortFn(a, b) {
      const dateA = new Date(a._create_time);
      const dateB = new Date(b._create_time);
      return dateA - dateB;
    },
    getResourcesName() {
      return "data";
    },
    getResourcesFn() {
      return this.app.listUnreadFormData;
    },
    getResourcesFnArgs() {
      const {
        formId,
        action,
      } = this;
      return {
        formId,
        action,
      };
    },
    generateMeta(resource) {
      return {
        id: resource._id,
        summary: `New Form Data: ${resource._id}`,
        ts: Date.parse(resource._create_time),
      };
    },
    async processResources(resources) {
      const {
        processEvent,
        formId,
        action,
      } = this;

      Array.from(resources)
        .reverse()
        .forEach(processEvent);

      const dataIds = resources.map(({ _id }) => _id);

      if (dataIds.length) {
        await this.app.markAsReadByAction({
          formId,
          action,
          data: {
            data_ids: dataIds,
          },
        });
      }
    },
  },
};

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
Kizeo Forms	`app`	`app`	This component uses the Kizeo Forms app.
Polling schedule	`timer`	`$.interface.timer`	How often to poll the API
Form ID	`formId`	`string`	Select a value from the drop down menu.
Action	`action`	`string`	Select a value from the drop down menu:`getpost`

Trigger Authentication#

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

Your API Token and Company Code are sent to your email when you request them via support@kizeo.com. For more info, refer to Kizeo Forms’s documentation

About Kizeo Forms#

Mobile Forms Application

Action#

Create Contact on BenchmarkONE

Description:Creates a new contact in BenchmarkONE. [See the documentation](https://sandbox.hatchbuck.com/api/dist/#!/Contacts/post_contact)

Version:0.0.1

Key:benchmarkone-create-contact

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import benchmarkone from "../../benchmarkone.app.mjs";
import { parseObject } from "../../common/utils.mjs";

export default {
  key: "benchmarkone-create-contact",
  name: "Create Contact",
  description: "Creates a new contact in BenchmarkONE. [See the documentation](https://sandbox.hatchbuck.com/api/dist/#!/Contacts/post_contact)",
  version: "0.0.1",
  type: "action",
  props: {
    benchmarkone,
    firstName: {
      propDefinition: [
        benchmarkone,
        "firstName",
      ],
      optional: true,
    },
    lastName: {
      propDefinition: [
        benchmarkone,
        "lastName",
      ],
      optional: true,
    },
    title: {
      propDefinition: [
        benchmarkone,
        "title",
      ],
      optional: true,
    },
    company: {
      propDefinition: [
        benchmarkone,
        "company",
      ],
      optional: true,
    },
    workEmail: {
      propDefinition: [
        benchmarkone,
        "workEmail",
      ],
      optional: true,
    },
    homeEmail: {
      propDefinition: [
        benchmarkone,
        "homeEmail",
      ],
      optional: true,
    },
    workPhone: {
      propDefinition: [
        benchmarkone,
        "workPhone",
      ],
      optional: true,
    },
    homePhone: {
      propDefinition: [
        benchmarkone,
        "homePhone",
      ],
      optional: true,
    },
    workAddress: {
      propDefinition: [
        benchmarkone,
        "workAddress",
      ],
      optional: true,
    },
    homeAddress: {
      propDefinition: [
        benchmarkone,
        "homeAddress",
      ],
      optional: true,
    },
    status: {
      propDefinition: [
        benchmarkone,
        "status",
      ],
    },
    temperature: {
      propDefinition: [
        benchmarkone,
        "temperature",
      ],
      optional: true,
    },
    website: {
      propDefinition: [
        benchmarkone,
        "website",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const emails = [];
      if (this.workEmail) {
        emails.push({
          address: this.workEmail,
          type: "Work",
        });
      }
      if (this.homeEmail) {
        emails.push({
          address: this.homeEmail,
          type: "Home",
        });
      }
      const phones = [];
      if (this.workPhone) {
        phones.push({
          number: this.workPhone,
          type: "Work",
        });
      }
      if (this.homePhone) {
        phones.push({
          number: this.homePhone,
          type: "Home",
        });
      }
      const addresses = [];
      if (this.workAddress) {
        addresses.push({
          ...parseObject(this.workAddress),
          type: "Work",
        });
      }
      if (this.homeAddress) {
        addresses.push({
          ...parseObject(this.homeAddress),
          type: "Home",
        });
      }

      const data = {
        contactId: this.contactId,
        firstName: this.firstName,
        lastName: this.lastName,
        emails,
        phones,
        addresses,
      };
      if (this.status) {
        data.status = {
          name: this.status.label,
          id: this.status.value,
        };
      }
      if (this.temperature) {
        data.temperature = {
          name: this.temperature.label,
          id: this.temperature.value,
        };
      }
      if (this.website) {
        data.website = [
          {
            websiteUrl: this.website,
          },
        ];
      }
      const response = await this.benchmarkone.createContact({
        $,
        data,
      });
      $.export("$summary", `Created contact with ID: ${response.contactId}`);
      return response;
    } catch (error) {
      throw new ConfigurationError(`Failed to create contact: ${error.message}`);
    }
  },
};

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
BenchmarkONE	`benchmarkone`	`app`	This component uses the BenchmarkONE app.
First Name	`firstName`	`string`	Contact's first name.
Last Name	`lastName`	`string`	Contact's last name.
Title	`title`	`string`	The contact's title.
Company	`company`	`string`	The contact's company name.
Work Email Address	`workEmail`	`string`	A contact's work email address.
Home Email Address	`homeEmail`	`string`	A contact's home email address.
Work Phone	`workPhone`	`string`	A contact's work phone number.
Home Phone	`homePhone`	`string`	A contact's home phone number.
Work Address	`workAddress`	`object`	An object of contact's work address.
Home Address	`homeAddress`	`object`	An object of contact's home address.
Status	`status`	`string`	Select a value from the drop down menu.
Temperature	`temperature`	`string`	Select a value from the drop down menu.
Website	`website`	`string`	The contact's website.