Create Customer with Zoho Books API on New Message Sent from WhatsApp Business API

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

Trigger workflow on

New Message Sent from the WhatsApp Business 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 WhatsApp Business 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 Message Sent trigger
1. Connect your WhatsApp Business account
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 Message Sent on WhatsApp Business

Description:Emit new event when a new message is sent or received. A Webhook subscribed to field "messages" must be set up from the App Dashboard of your [Facebook Developer Account](https://developers.facebook.com/). See [documentation](https://developers.facebook.com/docs/graph-api/webhooks/getting-started#configure-webhooks-product) for more information about Webhook setup.

Version:0.0.4

Key:whatsapp_business-new-message-sent

View on GitHub

WhatsApp Business Overview#

The WhatsApp Business API on Pipedream is a powerful avenue for automating interactions with customers on WhatsApp. You can send messages, set up automated responses, and manage conversations on a large scale. With Pipedream's serverless platform, you can create workflows that trigger from various events and connect WhatsApp Business with numerous other apps to automate tasks, notify teams, sync data, and more, all without managing infrastructure.

Trigger Code#

import whatsapp from "../../whatsapp_business.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "whatsapp_business-new-message-sent",
  name: "New Message Sent",
  description: "Emit new event when a new message is sent or received. A Webhook subscribed to field \"messages\" must be set up from the App Dashboard of your [Facebook Developer Account](https://developers.facebook.com/). See [documentation](https://developers.facebook.com/docs/graph-api/webhooks/getting-started#configure-webhooks-product) for more information about Webhook setup.",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    whatsapp,
    db: "$.service.db",
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
  },
  methods: {
    _getChallengeToken() {
      return this.db.get("challengeToken");
    },
    _setChallengeToken(challengeToken) {
      this.db.set("challengeToken", challengeToken);
    },
  },
  async run(event) {
    const {
      body, query,
    } = event;
    if (query["hub.challenge"]) {
      this._setChallengeToken(query["hub.challenge"]);
    }
    const challengeToken = this._getChallengeToken();

    this.httpInterface.respond({
      status: "200",
      body: challengeToken,
      headers: {
        "content-type": "application/json",
      },
    });

    if (!body) {
      return;
    }

    const entries = body?.entry || [];
    for (const entry of entries) {
      if (entry.changes && entry.changes?.length > 0) {
        const status = entry?.changes[0]?.value?.statuses
          ? entry?.changes[0]?.value?.statuses[0]?.status
          : null;
        if (status && status !== "sent") {
          continue;
        }
      }
      this.$emit(entry, {
        id: Date.now(),
        summary: "New Message Sent",
        ts: Date.now(),
      });
    }
  },
  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
WhatsApp Business	`whatsapp`	`app`	This component uses the WhatsApp Business app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`httpInterface`	`$.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#

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

To connect your WhatsApp Business Cloud account to Pipedream, follow the steps below to find your Business Account ID and your Permanent Access Token.

For additional info on setting up a WhatsApp Business account, refer to their getting started docs.

About WhatsApp Business#

WhatsApp Business products support businesses from large to small. Engage audiences, accelerate sales and drive better customer support outcomes on the platform with more than 2 billion users around the world.

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

About Zoho Books#

Online accounting software