← Zoom

Add Webinar Registrant with Zoom API

Pipedream makes it easy to connect APIs for Zoom and 800+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add Webinar Registrant with the Zoom API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Add Webinar Registrant with the Zoom API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add Webinar Registrant action
    1. Connect your Zoom account
    2. Configure webinar_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
    11. Optional- Configure state
    12. Optional- Configure phone
    13. Optional- Configure industry
    14. Optional- Configure org
    15. Optional- Configure job_title
    16. Optional- Configure purchasing_time_frame
    17. Optional- Configure role_in_purchase_process
    18. Optional- Configure no_of_employees
    19. Optional- Configure comments
    20. Optional- Configure custom_questions
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

Add Webinar Registrant on Zoom
Description:Registers a participant for a webinar.
Version:0.2.1
Key:zoom-add-webinar-registrant

Code

// legacy_hash_id: a_YEiPgP
import { axios } from "@pipedream/platform";

export default {
  key: "zoom-add-webinar-registrant",
  name: "Add Webinar Registrant",
  description: "Registers a participant for a webinar.",
  version: "0.2.1",
  type: "action",
  props: {
    zoom: {
      type: "app",
      app: "zoom",
    },
    webinar_id: {
      type: "string",
      description: "The webinar ID.",
    },
    occurrence_ids: {
      type: "string",
      description: "Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.",
      optional: true,
    },
    email: {
      type: "string",
      description: "A valid email address of the registrant.",
    },
    first_name: {
      type: "string",
      description: "Registrant's first name.",
    },
    last_name: {
      type: "string",
      description: "Registrant's last name.",
    },
    address: {
      type: "string",
      description: "Registrant's address.",
      optional: true,
    },
    city: {
      type: "string",
      description: "Registrant's city.",
      optional: true,
    },
    country: {
      type: "string",
      description: "Registrant's country.",
      optional: true,
    },
    zip: {
      type: "string",
      description: "Registrant's Zip/Postal code.",
      optional: true,
    },
    state: {
      type: "string",
      description: "Registrant's State/Province.",
      optional: true,
    },
    phone: {
      type: "string",
      description: "Registrant's Phone number.",
      optional: true,
    },
    industry: {
      type: "string",
      description: "Registrant's industry.",
      optional: true,
    },
    org: {
      type: "string",
      description: "Registrant's Organization.",
      optional: true,
    },
    job_title: {
      type: "string",
      description: "Registrant's job title.",
      optional: true,
    },
    purchasing_time_frame: {
      type: "string",
      description: "This field can be included to gauge interest of webinar attendees towards buying your product or service.",
      optional: true,
    },
    role_in_purchase_process: {
      type: "string",
      description: "Role in Purchase Process.",
      optional: true,
    },
    no_of_employees: {
      type: "string",
      description: "Number of Employees.",
      optional: true,
    },
    comments: {
      type: "string",
      description: "A field that allows registrants to provide any questions or comments that they might have.",
      optional: true,
    },
    custom_questions: {
      type: "any",
      description: "Custom questions.",
      optional: true,
    },
  },
  async run({ $ }) {
  //See the API docs here: https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrantcreate
    const config = {
      method: "post",
      url: `https://api.zoom.us/v2/webinars/${this.webinar_id}/registrants`,
      params: {
        occurrence_ids: this.occurrence_ids,
      },
      data: {
        email: this.email,
        first_name: this.first_name,
        last_name: this.last_name,
        address: this.address,
        city: this.city,
        country: this.country,
        zip: this.zip,
        state: this.state,
        phone: this.phone,
        industry: this.industry,
        org: this.org,
        job_title: this.job_title,
        purchasing_time_frame: this.purchasing_time_frame,
        role_in_purchase_process: this.role_in_purchase_process,
        no_of_employees: this.no_of_employees,
        comments: this.comments,
        custom_questions: typeof this.custom_questions == "undefined"
          ? this.custom_questions
          : JSON.parse(this.custom_questions),
      },
      headers: {
        "Authorization": `Bearer ${this.zoom.$auth.oauth_access_token}`,
        "Content-Type": "application/json",
      },
    };
    return await axios($, config);
  },
};

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.
LabelPropTypeDescription
ZoomzoomappThis component uses the Zoom app.
webinar_idstring

The webinar ID.

occurrence_idsstring

Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.

emailstring

A valid email address of the registrant.

first_namestring

Registrant's first name.

last_namestring

Registrant's last name.

addressstring

Registrant's address.

citystring

Registrant's city.

countrystring

Registrant's country.

zipstring

Registrant's Zip/Postal code.

statestring

Registrant's State/Province.

phonestring

Registrant's Phone number.

industrystring

Registrant's industry.

orgstring

Registrant's Organization.

job_titlestring

Registrant's job title.

purchasing_time_framestring

This field can be included to gauge interest of webinar attendees towards buying your product or service.

role_in_purchase_processstring

Role in Purchase Process.

no_of_employeesstring

Number of Employees.

commentsstring

A field that allows registrants to provide any questions or comments that they might have.

custom_questionsany

Custom questions.

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:

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.