Create Customer with Zoho Books API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Zoho Books, Typeform and 2,400+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

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

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Customer action
1. Connect your Zoho Books account
2. Configure Contact Name
3. Optional- Configure Company Name
4. Optional- Configure Website
5. Optional- Select a Language Code
6. Optional- Select a Customer Sub Type
7. Optional- Configure Credit Limit
8. Optional- Configure Tags
9. Optional- Configure Is Portal Enabled
10. Optional- Select a Currency Id
11. Optional- Configure Payment Terms
12. Optional- Configure Payment Terms Label
13. Optional- Configure Notes
14. Optional- Configure Exchange Rate
15. Optional- Configure VAT Treatment
16. Optional- Configure GST No
17. Optional- Configure Avatax Use Code
18. Optional- Select a Tax 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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Customer on Zoho Books

Description:Creates a new customer. [See the documentation](https://www.zoho.com/books/api/v3/items/#create-an-item)

Version:0.0.1

Key:zoho_books-create-customer

View on GitHub

Zoho Books Overview#

Zoho Books API unlocks the potential to automate and streamline accounting tasks by integrating with Pipedream's serverless platform. With this powerful combo, you can automate invoicing, manage your accounts, reconcile bank transactions, and handle contacts and items without manual input. By setting up event-driven workflows, you can ensure data consistency across platforms, trigger notifications, and generate reports, all while saving time and reducing human error.

Action Code#

// legacy_hash_id: a_Xzi1qo
import {
  CUSTOMER_SUB_TYPE_OPTIONS,
  LANGUAGE_CODE_OPTIONS,
} from "../../common/constants.mjs";
import {
  clearObj,
  parseObject,
} from "../../common/utils.mjs";
import zohoBooks from "../../zoho_books.app.mjs";

export default {
  key: "zoho_books-create-customer",
  name: "Create Customer",
  description: "Creates a new customer. [See the documentation](https://www.zoho.com/books/api/v3/items/#create-an-item)",
  version: "0.0.1",
  type: "action",
  props: {
    zohoBooks,
    contactName: {
      type: "string",
      label: "Contact Name",
      description: "Display Name of the contact. Max-length [200].",
    },
    companyName: {
      type: "string",
      label: "Company Name",
      description: "Company Name of the contact. Max-length [200].",
      optional: true,
    },
    website: {
      type: "string",
      label: "Website",
      description: "Website of the contact.",
      optional: true,
    },
    languageCode: {
      type: "string",
      label: "Language Code",
      description: "The language of a contact.",
      options: LANGUAGE_CODE_OPTIONS,
      optional: true,
    },
    customerSubType: {
      type: "string",
      label: "Customer Sub Type",
      description: "Type of the customer.",
      options: CUSTOMER_SUB_TYPE_OPTIONS,
      optional: true,
    },
    creditLimit: {
      type: "string",
      label: "Credit Limit",
      description: "Credit limit for a customer.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "An array of tag objects. **Example: {\"tag_id\":\"124567890\",\"tag_option_id\":\"1234567890\"}**",
      optional: true,
    },
    isPortalEnabled: {
      type: "boolean",
      label: "Is Portal Enabled",
      description: "To enable client portal for the contact.",
      optional: true,
    },
    currencyId: {
      propDefinition: [
        zohoBooks,
        "currencyId",
      ],
      optional: true,
    },
    paymentTerms: {
      propDefinition: [
        zohoBooks,
        "paymentTerms",
      ],
      description: "Net payment term for the customer.",
      optional: true,
    },
    paymentTermsLabel: {
      propDefinition: [
        zohoBooks,
        "paymentTermsLabel",
      ],
      description: "Label for the paymet due details.",
      optional: true,
    },
    notes: {
      propDefinition: [
        zohoBooks,
        "notes",
      ],
      description: "Commennts about the payment made by the contact.",
      optional: true,
    },
    exchangeRate: {
      propDefinition: [
        zohoBooks,
        "exchangeRate",
      ],
      description: "Exchange rate for the opening balance.",
      optional: true,
    },
    vatTreatment: {
      propDefinition: [
        zohoBooks,
        "vatTreatment",
      ],
      optional: true,
    },
    gstNo: {
      propDefinition: [
        zohoBooks,
        "gstNo",
      ],
      optional: true,
    },
    avataxUseCode: {
      propDefinition: [
        zohoBooks,
        "avataxUseCode",
      ],
      optional: true,
    },
    taxId: {
      propDefinition: [
        zohoBooks,
        "taxId",
      ],
      description: "ID of the tax to be associated to the estimate.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.zohoBooks.createContact({
      $,
      data: clearObj({
        contact_name: this.contactName,
        company_name: this.companyName,
        website: this.website,
        language_code: this.languageCode,
        contact_type: "customer",
        customer_sub_type: this.customerSubType,
        credit_limit: this.creditLimit,
        tags: parseObject(this.tags),
        is_portal_enabled: this.isPortalEnabled,
        currency_id: this.currencyId,
        payment_terms: this.paymentTerms,
        payment_terms_label: this.paymentTermsLabel,
        notes: this.notes,
        exchange_rate: this.exchangeRate && parseFloat(this.exchangeRate),
        vat_treatment: this.vatTreatment,
        gst_no: this.gstNo,
        avatax_use_code: this.avataxUseCode,
        tax_id: this.taxId,
      }),
    });

    $.export("$summary", `Contact successfully created with Id: ${response.contact.contact_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
Zoho Books	`zohoBooks`	`app`	This component uses the Zoho Books app.
Contact Name	`contactName`	`string`	Display Name of the contact. Max-length [200].
Company Name	`companyName`	`string`	Company Name of the contact. Max-length [200].
Website	`website`	`string`	Website of the contact.
Language Code	`languageCode`	`string`	Select a value from the drop down menu:`deenesfritjanlptpt_brsvzhen_gb`
Customer Sub Type	`customerSubType`	`string`	Select a value from the drop down menu:`businessindividual`
Credit Limit	`creditLimit`	`string`	Credit limit for a customer.
Tags	`tags`	`string[]`	An array of tag objects. Example: {"tag_id":"124567890","tag_option_id":"1234567890"}
Is Portal Enabled	`isPortalEnabled`	`boolean`	To enable client portal for the contact.
Currency Id	`currencyId`	`string`	Select a value from the drop down menu.
Payment Terms	`paymentTerms`	`integer`	Net payment term for the customer.
Payment Terms Label	`paymentTermsLabel`	`string`	Label for the paymet due details.
Notes	`notes`	`string`	Commennts about the payment made by the contact.
Exchange Rate	`exchangeRate`	`string`	Exchange rate for the opening balance.
VAT Treatment	`vatTreatment`	`string`	Enter vat treatment.
GST No	`gstNo`	`string`	15 digit GST identification number of the customer.
Avatax Use Code	`avataxUseCode`	`string`	Used to group like customers for exemption purposes. It is a custom value that links customers to a tax rule.
Tax Id	`taxId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

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

ZohoBooks.fullaccess.all