Create Customer Order with Workbooks CRM API on Custom Events (Instant) from Zoom API

Pipedream makes it easy to connect APIs for Workbooks CRM, Zoom and 2,000+ other apps remarkably fast.

Trigger workflow on

Custom Events (Instant) from the Zoom API

Next, do this

Create Customer Order with the Workbooks CRM API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Zoom trigger and Workbooks CRM action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the Custom Events (Instant) trigger
1. Connect your Zoom account
2. Select one or more Zoom Events
3. Configure apphook
Configure the Create Customer Order action
1. Connect your Workbooks CRM account
2. Select a Assigned To
3. Configure Customer Order Name
4. Configure Document Currency
5. Configure Customer Order Date
6. Configure Status
7. Configure Tax Point Date
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#

Custom Events (Instant) on Zoom

Description:Emit new events tied to your Zoom user or resources you own

Version:0.1.0

Key:zoom-custom-event

View on GitHub

Zoom Overview#

Connecting Zoom to any app using Pipedream

Pipedream workflows allow you to run any Node.js code that connects to the Zoom API. Just create a new workflow, then add prebuilt Zoom actions (create a meeting, send a chat message, etc.) or write your own code. These workflows can be triggered by HTTP requests, timers, email, or on any app-based event (new tweets, a Github PR, Zoom events, etc).

Getting Started

First, sign up for Pipedream at https://pipedream.com.
Visit https://pipedream.com/accounts.
Click the button labeled Click Here to Connect an App.
Search for "Zoom" and select either Zoom or Zoom Admin (see the differences below):

This will open up a new window prompting you to authorize Pipedream's access to your Zoom account. Once you authorize access, you should see your Zoom account listed among your apps.

Create a new workflow, add a new step, search for "Zoom" or "Zoom Admin". Once you've selected either app, you can choose to either "Run Node.js code" or select one of the prebuilt actions for performing common API operations.
At this stage, you'll be asked to link the Zoom account you connected above, authorizing the request to the Zoom API with your credentials:

Zoom vs Zoom Admin app

Zoom users can be classified into two groups: non-admins and admins. Admins have account-level permissions that users do not, and Zoom has corresponding admin-level scopes that aren't relevant for normal users. Therefore, Pipedream exposes two apps — Zoom and Zoom Admin — to serve the two groups.

In the Zoom Marketplace, these apps are named Pipedream, and Pipedream for Zoom Admins, respectively.

Non-admins have permissions to manage standard Zoom resources in their account: meetings, webinars, recordings, and more. If you're a non-admin, you'll want to use the Zoom app.

Zoom admins have permissions to manage account-level resources, like users and reports. They can also manage webinars and meetings across their organization. If you're an admin and need to manage these resources via API, you'll want to use the Zoom Admin app.

The Zoom API docs on permissions provide detailed information on these permissions and their associated OAuth scopes.

Trigger Code#

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

export default {
  ...common,
  key: "zoom-custom-event",
  name: "Custom Events (Instant)",
  description: "Emit new events tied to your Zoom user or resources you own",
  version: "0.1.0",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventNameOptions: {
      type: "string[]",
      label: "Zoom Events",
      description: "Select the events you want to listen for",
      options: Object.values(constants.CUSTOM_EVENT_TYPES),
    },
    // eslint-disable-next-line pipedream/props-label, pipedream/props-description
    apphook: {
      type: "$.interface.apphook",
      appProp: "app",
      eventNames() {
        return this.eventNameOptions;
      },
    },
  },
  async run(event) {
    this.$emit(event, {
      id: event.payload?.object?.id,
      summary: event.event,
      ts: Date.now(),
    });
  },
};

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
Zoom	`app`	`app`	This component uses the Zoom app.
Zoom Events	`eventNameOptions`	`string[]`	Select a value from the drop down menu:`meeting.alertmeeting.created.by_memeeting.created.for_memeeting.updatedmeeting.deleted.by_memeeting.deleted.for_memeeting.startedmeeting.endedmeeting.registration_createdmeeting.registration_approvedmeeting.registration_cancelledmeeting.registration_deniedmeeting.sharing_started.hostmeeting.sharing_started.participantmeeting.sharing_ended.hostmeeting.sharing_ended.participantmeeting.participant_jbh_joinedmeeting.participant_jbh_waitingmeeting.participant_joinedmeeting.participant_leftmeeting.participant_joined_waiting_roommeeting.participant_admittedmeeting.participant_put_in_waiting_roommeeting.participant_left_waiting_roomrecording.startedrecording.pausedrecording.resumedrecording.stoppedrecording.completedrecording.trashed.by_merecording.trashed.for_merecording.deleted.by_merecording.deleted.for_merecording.recovered.by_merecording.recovered.for_merecording.transcript_completedrecording.registration_createdrecording.registration_approvedrecording.registration_denieduser.updateduser.settings_updateduser.signed_inuser.signed_outwebinar.created.by_mewebinar.created.for_mewebinar.updatedwebinar.startedwebinar.endedwebinar.alertwebinar.sharing_started.hostwebinar.sharing_started.participantwebinar.sharing_endedwebinar.registration_createdwebinar.registration_approvedwebinar.registration_deniedwebinar.registration_cancelledwebinar.participant_joinedwebinar.participant_leftwebinar.deleted.by_mewebinar.deleted.for_me`
	`apphook`	`$.interface.apphook`

Trigger Authentication#

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

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

zoom_events_basic:read

About Zoom#

Zoom is the leader in modern enterprise video communications, with an easy, reliable cloud platform for video and audio conferencing, chat, and webinars.

Action#

Create Customer Order on Workbooks CRM

Description:Creates an order from your customers for your goods or services.

Version:0.0.1

Key:workbooks_crm-create-customer-order

View on GitHub

Workbooks CRM Overview#

Using Workbook CRM's powerful API, you have the opportunity to build powerful
business applications like never before. With its intuitive interface,
streamlined processes and wraparound features, the Workbooks CRM API offers
sophisticated software solutions to meet a variety of organizational needs.

From custom tailored customer Account and Contact Management dashboards to
project tracking and sales order automation, the Workbooks CRM API enables you
to create, store and access data seamlessly. With its secure, cloud-based
architecture, you can create, update, delete and query data, ensuring that only
authorized personnel can access the necessary materials.

The areas you can build with the Workbooks CRM API, include:

Customizable customer account and contact management
Real-time project tracking and asset management
Sales order automation
Accurate data collection and analysis
Automated CRM reporting
Powerful marketing automation tools
Robust service management and support
Streamlined customer onboarding processes
Comprehensive B2B and B2C portals
User-friendly lead and opportunity management

Action Code#

import app from "../../workbooks_crm.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "workbooks_crm-create-customer-order",
  name: "Create Customer Order",
  description: "Creates an order from your customers for your goods or services.",
  type: "action",
  version: "0.0.1",
  props: {
    app,
    assignedTo: {
      label: "Assigned To",
      description: "A queue that this Customer Order could be assigned to.",
      propDefinition: [
        app,
        "orderQueue",
      ],
    },
    description: {
      type: "string",
      label: "Customer Order Name",
      description: "The description of this Customer Order.",
    },
    documentCurrency: {
      type: "string",
      label: "Document Currency",
      description: "The currency of this Transaction in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format. E.g. `USD`.",
    },
    documentDate: {
      type: "string",
      label: "Customer Order Date",
      description: "The official date for this Customer Order.",
      default: utils.getCurrentDate(),
    },
    status: {
      type: "string",
      label: "Status",
      description: "The status of this Transaction.",
      default: "DRAFT",
    },
    taxPointDate: {
      type: "string",
      label: "Tax Point Date",
      description: "The date that sales tax will be calculated for this Transaction.",
      default: utils.getCurrentDate(),
    },
  },
  async run({ $: step }) {
    const {
      assignedTo,
      description,
      documentCurrency,
      documentDate,
      status,
      taxPointDate,
    } = this;

    const response = await this.app.createOrder({
      step,
      data: {
        assigned_to: [
          assignedTo,
        ],
        description: [
          description,
        ],
        document_currency: [
          documentCurrency,
        ],
        document_date: [
          documentDate,
        ],
        status: [
          status,
        ],
        tax_point_date: [
          taxPointDate,
        ],
      },
    });

    step.export("$summary", `Successfully created customer order with ID ${response.affected_objects[0].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
Workbooks CRM	`app`	`app`	This component uses the Workbooks CRM app.
Assigned To	`assignedTo`	`string`	Select a value from the drop down menu.
Customer Order Name	`description`	`string`	The description of this Customer Order.
Document Currency	`documentCurrency`	`string`	The currency of this Transaction in ISO 4217 format. E.g. `USD`.
Customer Order Date	`documentDate`	`string`	The official date for this Customer Order.
Status	`status`	`string`	The status of this Transaction.
Tax Point Date	`taxPointDate`	`string`	The date that sales tax will be calculated for this Transaction.

Action Authentication#

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