Plugin - Zoom (Create user registration forms)

RSForm!Pro Zoom Plugin
 

The RSForm!Pro Zoom plugin allows you to connect to your Zoom Meeting / Webinar and map form data within the mandatory or optional fields. When the form is submitted, the integration is done silently while running in the background, so the user (form submitter) will not notice anything in the frontend.

 
Downloading and Installing the plugin
Download

You can download the plugin by logging with your purchase user, then head to My Downloads > RSForm!Pro - Modules & Plugins > Plugins > "Zoom x.x Plugin".

Install

Go to the Extensions > Manager > Install page, and install the plugin. Next thing is to publish the plugin from Extensions > Plugins, search for the "System - RSForm! Pro Zoom" plugin.


Setting up Zoom API Keys

 
App Type - JWT (deprecated)

The JWT application type requires two Keys, API Key and API Secret Key. Both can be generated from your Zoom account. You will make sure to create a JWT application from Develop > Build App area.

The Users List Page Size option allows you to specify how many users should be retrieved per page, when selecting the user.

 

App Type - Server-to-Server OAuth

The Server-to-Server OAuth application type requires the followings credentials:

  • Account ID: Enter your Zoom Account ID
  • Client ID: Enter your Zoom Client ID
  • Client secret: Enter your Zoom Client secret key

These can be generated from your Zoom account. You will make sure to create an Server-to-Server OAuth application from Develop > Build App area.

The Users List Page Size option allows you to specify how many users should be retrieved per page, when selecting the user.

 

Creating a Server-to-Server OAuth app
Step 1.

Login to your Zoom account and select 'Server-to-Server OAuth', then name your new App as desired.

 

Step 2.

Go to Scopes tab and select the following scopes:

a) in the Meetings tab:

  • View and manage sub account’s user meetings/meeting:master
  • View all user meetings/meeting:read:admin
  • View and manage all user meetings/meeting:write:admin
 

b) in the Webinars tab:

  • View and manage sub account’s user webinars/webinar:master
  • View all user Webinars/webinar:read:admin
  • View and manage all user Webinars/webinar:write:admin
 

c) in the User tab:

  • View and manage sub account’s user information/user:master
  • View all user information/user:read:admin
  • View users information and manage users/user:write:admin
 

Step 3.

Go to App Credentials tab and copy the 'Account ID / Client ID / Client secret', then paste them into RSForm!Pro > Configuration > Zoom tab.

 

Scheduling a Meeting in Zoom

Next, you will be able to schedule a meeting from your Zoom account. Note that the 'Registration' option needs to be required in order for the integration to work.

The "Registration" option will only be available for paid Zoom accounts.
 

Scheduling a Webinar in Zoom

Next, you will be able to schedule a webinar from your Zoom account. Note that the 'Registration' option needs to be required in order for the integration to work.

The "Registration" option will only be available for paid Zoom accounts.
 

Configuring the integration
  • Access your form in the backend > Components > RSForm!Pro > Manage Forms > your form > Form Properties > Zoom tab.
  • Enable the "Use Zoom" option.
  • If the 'Add Registrant When Payment is Complete' option is enabled, the user will be added to only after the payment has been confirmed by using the 'Confirm Payment' button while editing the submission. Confirming a payment is used when for some reason the gateway did not confirm it or when using Wire Transfer methods were payment is confirmed manually by you.
  • When enabling the 'Show API Messages' the error messages will be displayed upon submission.
  • The 'Confirmation Emails Language' option allows choosing a certain language for your Zoom confirmation emails or to dynamically use your Joomla! site language (default being set to use your frontend Joomla! language).
  • From the User dropdown you will need to select a user from your account so that the meetings / webinars can be loaded
  • Finally, choose the 'Meeting' or 'Webinar' on which users will be added.
 

The following placeholders can be used to return the Join URL and the Password needed to participate to a Zoom meeting:

  • {zoom_join_url}
  • {zoom_password}

If your meeting requires registration, the following placeholder will also be available:

  • {zoom_registration_url}


Mandatory fields that will require mapping:

  • Email - as the name implies, this will be the registered user email.
  • Name - the registered user name.
  • Last Name - the registered user last name.
 
04 Mar 2024
Version 3.0.3
  • Added - Joomla! 5 native compatibility - no longer needs the 'Behaviour - Backward Compatibility' plugin.
13 Dec 2022
Version 3.0.2
  • Added - Support for Server-to-Server OAuth.
09 Jul 2021
Version 3.0.1
  • Fixed - Registrant is now added automatically when payment total is 0 and 'Add Registrant When Payment is Complete' is set to 'Yes'.
09 Jun 2021
Version 3.0.0
  • Updated - Joomla! 4.0 and RSForm! Pro 3.0 compatibility.
09 Apr 2021
Version 1.0.6
  • Fixed - Zoom error messages were not escaped in the log.
  • Fixed - 'Clear all errors' button was not translated.
20 Jan 2021
Version 1.0.5
  • Added - {zoom_meeting_id} placeholder.
  • Added - 'User List Page Size' configuration option.
  • Updated - Users from larger accounts (30+) can now be selected.
03 Nov 2020
Version 1.0.4
  • Updated - Choose between 'Meetings' and 'Webinars'.
15 Sep 2020
Version 1.0.3
  • Added - 'Confirmation Emails Language' can be configured.
23 Jun 2020
Version 1.0.2
  • Added - Zoom Registration Status can be shown in the Directory.
  • Added - {_ZOOM_STATUS:value} and {_ZOOM_STATUS:caption} placeholders to retrieve the registration status.
22 Jun 2020
Version 1.0.1
  • Updated - {zoom_join_url} now directly joins the user to the meeting.
18 May 2020
Initial Release

20 persons found this article helpful.


Was this article helpful?

Yes No
Sorry about that

You Should Also Read

Plugin - PDF (Attach an automatically generated PDF to an email) HOT

Plugin - SMS Notification (Send a SMS to a mobile phone number) HOT

Plugin - RSEvents!Pro (Create custom event registration forms) HOT

Ticket PDF plugin HOT

Plugin - External Mailer (Use different email settings and add DKIM support) HOT