Add Meeting Registrant with Zoom API on New Task (Instant) from awork API

Pipedream makes it easy to connect APIs for Zoom, awork and 1,600+ other apps remarkably fast.

Trigger workflow on

New Task (Instant) from the awork API

Next, do this

Add Meeting Registrant with the Zoom API

No credit card required

▶

Watch us build a workflow

7 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Task (Instant) trigger
1. Connect your awork account
Configure the Add Meeting Registrant action
1. Connect your Zoom account
2. Optional- Select a Meeting ID
3. Optional- Configure Occurrence IDs
4. Configure Email
5. Configure First Name
6. Configure Last Name
7. Optional- Configure Address
8. Optional- Configure City
9. Optional- Configure Country
10. Optional- Configure Zip/Postal Code
11. Optional- Configure State/Province
12. Optional- Configure Phone
13. Optional- Configure Industry
14. Optional- Configure Organization
15. Optional- Configure Job Title
16. Optional- Configure Purchasing Time Frame
17. Optional- Configure Role in Purchase Process
18. Optional- Configure Number of Employees
19. Optional- Configure Comments
20. Optional- Configure Custom Questions
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 Task (Instant) on awork

Description:Emit new event on each created task.

Version:0.0.1

Key:awork-new-task

View on GitHub

awork Overview#

The awork API allows developers to access awork.io content and build
applications on top of the awork platform. With the awork API, you can:

Access awork.io content, including articles, photos, and videos
Build applications on top of the awork platform
Integrate awork.io content into your own website or application

Trigger Code#

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

export default {
  ...common,
  name: "New Task (Instant)",
  version: "0.0.1",
  key: "awork-new-task",
  description: "Emit new event on each created task.",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getWebhookEventType() {
      return "task_added";
    },
    async deploy() {
      const tasks = await this.awork.getTasks({
        params: {
          pageSize: 10,
          orderby: "CreatedOn DESC",
        },
      });

      tasks.reverse().forEach(this.emitEvent);
    },
    emitEvent(body) {
      const data = body?.entity ?? body;

      this.$emit(data, {
        id: data.id,
        summary: `New task created with id ${data.id}`,
        ts: Date.parse(data.createdOn),
      });
    },
  },
};

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
awork	`awork`	`app`	This component uses the awork app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.

Trigger Authentication#

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

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

offline_access

About awork#

Your smart digital assistant

Action#

Add Meeting Registrant on Zoom

Description:Registers a participant for a meeting. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/meetingRegistrantCreate)

Version:0.3.0

Key:zoom-add-meeting-registrant

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.

Action Code#

import app from "../../zoom.app.mjs";

export default {
  key: "zoom-add-meeting-registrant",
  name: "Add Meeting Registrant",
  description: "Registers a participant for a meeting. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/meetingRegistrantCreate)",
  version: "0.3.0",
  type: "action",
  props: {
    app,
    meetingId: {
      propDefinition: [
        app,
        "meetingId",
      ],
    },
    occurrenceIds: {
      propDefinition: [
        app,
        "occurrenceIds",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    firstName: {
      propDefinition: [
        app,
        "firstName",
      ],
    },
    lastName: {
      propDefinition: [
        app,
        "lastName",
      ],
    },
    address: {
      propDefinition: [
        app,
        "address",
      ],
    },
    city: {
      propDefinition: [
        app,
        "city",
      ],
    },
    country: {
      propDefinition: [
        app,
        "country",
      ],
    },
    zip: {
      propDefinition: [
        app,
        "zip",
      ],
    },
    state: {
      propDefinition: [
        app,
        "state",
      ],
    },
    phone: {
      propDefinition: [
        app,
        "phone",
      ],
    },
    industry: {
      propDefinition: [
        app,
        "industry",
      ],
    },
    org: {
      propDefinition: [
        app,
        "org",
      ],
    },
    jobTitle: {
      propDefinition: [
        app,
        "jobTitle",
      ],
    },
    purchasingTimeFrame: {
      propDefinition: [
        app,
        "purchasingTimeFrame",
      ],
    },
    roleInPurchaseProcess: {
      propDefinition: [
        app,
        "roleInPurchaseProcess",
      ],
    },
    noOfEmployees: {
      propDefinition: [
        app,
        "noOfEmployees",
      ],
    },
    comments: {
      propDefinition: [
        app,
        "comments",
      ],
    },
    customQuestions: {
      propDefinition: [
        app,
        "customQuestions",
      ],
    },
  },
  methods: {
    addMeetingRegistrant({
      meetingId, ...args
    } = {}) {
      return this.app.create({
        path: `/meetings/${meetingId}/registrants`,
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      meetingId,
      occurrenceIds,
      email,
      firstName,
      lastName,
      address,
      city,
      country,
      zip,
      state,
      phone,
      industry,
      org,
      jobTitle,
      purchasingTimeFrame,
      roleInPurchaseProcess,
      noOfEmployees,
      comments,
      customQuestions,
    } = this;

    const response = await this.addMeetingRegistrant({
      step,
      meetingId,
      params: {
        occurrence_ids: occurrenceIds,
      },
      data: {
        email,
        first_name: firstName,
        last_name: lastName,
        address,
        city,
        country,
        zip,
        state,
        phone,
        industry,
        org,
        job_title: jobTitle,
        purchasing_time_frame: purchasingTimeFrame,
        role_in_purchase_process: roleInPurchaseProcess,
        no_of_employees: noOfEmployees,
        comments,
        custom_questions: typeof(customQuestions) === "undefined"
          ? customQuestions
          : JSON.parse(customQuestions),
      },
    });

    step.export("$summary", `Successfully added registrant to meeting with ID \`${response.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
Zoom	`app`	`app`	This component uses the Zoom app.
Meeting ID	`meetingId`	`integer`	Select a value from the drop down menu.
Occurrence IDs	`occurrenceIds`	`string`	Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.
Email	`email`	`string`	A valid email address of the registrant.
First Name	`firstName`	`string`	Registrant's first name.
Last Name	`lastName`	`string`	Registrant's last name.
Address	`address`	`string`	Registrant's address.
City	`city`	`string`	Registrant's city.
Country	`country`	`string`	Registrant's country.
Zip/Postal Code	`zip`	`string`	Registrant's Zip/Postal code.
State/Province	`state`	`string`	Registrant's State/Province.
Phone	`phone`	`string`	Registrant's Phone number.
Industry	`industry`	`string`	Registrant's industry.
Organization	`org`	`string`	Registrant's Organization.
Job Title	`jobTitle`	`string`	Registrant's job title.
Purchasing Time Frame	`purchasingTimeFrame`	`string`	This field can be included to gauge interest of webinar attendees towards buying your product or service.
Role in Purchase Process	`roleInPurchaseProcess`	`string`	Role in Purchase Process.
Number of Employees	`noOfEmployees`	`string`	Number of Employees.
Comments	`comments`	`string`	A field that allows registrants to provide any questions or comments that they might have.
Custom Questions	`customQuestions`	`string`	Custom questions.

Action 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.