Plugin Directory

Changeset 3267953


Ignore:
Timestamp:
04/07/2025 02:30:43 PM (10 months ago)
Author:
apos37
Message:

Update readme to include FAQs with common reasons it does not work

Location:
gravity-zwr
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • gravity-zwr/tags/1.4.0/readme.txt

    r3266575 r3267953  
    1212
    1313== Description ==
    14 
    1514This plugin adds a "Zoom Registration" feed to your Gravity Forms. Although it was created specifically for the Webinars feature on Zoom, it will also work with regular Meetings.
    1615
     
    2019
    2120== Requirements ==
    22 
    23211. A WordPress.org based website
    24222. The [Gravity Forms](https://www.gravityforms.com/) plugin
     
    3028
    3129== Third-Party Services ==
    32 
    3330This plugin integrates with the Zoom API to facilitate registration for webinars and meetings. By using this plugin, you acknowledge that certain data will be transmitted to Zoom in order to create and manage webinar registrants.
    3431
     
    4340For any concerns regarding data transmission and processing, please refer to the links above to understand how your information is handled by Zoom.
    4441
    45 
    4642== Installation ==
    47 
    48431. Install the plugin from your website's plugin directory, or upload the plugin to your plugins folder.
    49442. Activate it.
     
    5247
    5348== Usage ==
    54 
    55491. After installation, go to **Gravity Forms > Settings > Zoom Webinar**. Enter your [Server OAuth App](https://marketplace.zoom.us/docs/guides/build/server-to-server-oauth-app/) Account ID, Client ID, and Client Secret. These apps are free to create, take only 5 minutes, and don't need to be published. Fill in all three fields and hit Save.
    56502. Follow the directions on the Zoom API docs carefully. You’ll need to edit roles in Zoom settings and create the app. Your user role and app must have the `meeting:write:admin` and `webinar:write:admin` scopes. If you are having issues, you may need to add the following scopes: `meeting:write:registrant:admin` and `meeting:read:list_meetings:admin`.
     
    6256
    6357== Constants ==
    64 
    6558By default, this plugin will ask for your Account ID, Client ID & Secret in the Gravity Forms settings. Users wanting more control can specify these as constants: `GRAVITYZWR_ACCOUNT_ID`, `GRAVITYZWR_CLIENT_ID`, and `GRAVITYZWR_CLIENT_SECRET`.
    6659
    6760== Payments ==
    68 
    6961This add-on supports delayed payment through the Gravity Forms PayPal add-on. Charge for registrations via PayPal, processing the Zoom Registration feed only upon successful payment. [Read more here.](https://docs.gravityforms.com/setting-up-paypal-payments-standard/)
    7062
    71 == Retrieving Join Link URL ==
    72 
    73 Starting from version 1.4, a Join Link field has been added to the Zoom Webinar feed registation fields section. If you want the join link to populate into a hidden field on the entry, then just choose the field you want from your form.
    74 
    7563== Migrating from Old Plugin ==
    76 
    7764This plugin uses the same text domain as the other one by Michael Bourne, so all of the settings and webinar feeds that you previously set up will remain. All you need to do is install and activate this plugin while the other one is activated. No need to set everything up again. :)
    7865
    79 == Mapping Custom Questions == 
     66== Frequently Asked Questions ==
     67= The registration did not go through, what happened? =
     68There could be several reasons. You can check for an error in the entry details notes, which should give you a good indication of what happened. Some common reasons include:
     69* You didn't actually set up the plugin or a webinar/meeting feed
     70* The Account ID, Client ID, and/or Client Secret are incorrect
     71* Incorrect scopes set
     72* A field is required on your Zoom registration form but not mapped on the plugin feed
     73* The webinar or meeting with the ID you entered does not exist
     74* The feed is set to a webinar when it should be a meeting or vice versa
     75* The webinar/meeting host can not register
     76* User's email cannot register for the same webinar/meeting more than 3 times in 24 hours
    8077
    81 Starting from version 1.4, you can map custom questions to your Zoom registration by using a simple code snippet in your website’s theme. This allows you to include additional fields beyond the default ones.
     78= How do I retrieve the join link URL after registration? =
     79A Join Link field has been added to the Zoom Webinar feed registation fields section. If you want the join link to populate into a hidden field on the entry, then just choose the field you want from your form.
    8280
    83 To do this, you’ll need to add a small piece of code to your theme’s `functions.php` file. In the example below, we’re adding a custom question called “Referral Source.” The **name** in the code must exactly match the field name used in your Zoom registration.
    84 
    85 Here’s the code you need to add:
     81= How do I map custom questions? =
     82You can map custom questions to your Zoom registration by using a simple code snippet in your website’s theme. This allows you to include additional fields beyond the default ones. To do this, you’ll need to add a small piece of code to your theme’s `functions.php` file. In the example below, we’re adding a custom question called “Referral Source.” The **name** in the code must exactly match the field name used in your Zoom registration. Once this is added, the “Referral Source” field will be included in your Gravity Forms Zoom Webinar feed settings. Here’s the code you need to add:
    8683
    8784`add_filter( 'gravityzwr_registration_fields', function( $fields ) { 
     
    9289    ]; 
    9390    return $fields; 
    94 } );` 
    95 
    96 Once this is added, the “Referral Source” field will be included in your Gravity Forms Zoom Webinar feed settings.
    97 
    98 == Support ==
     91} );`
    9992
    10093= Where can I request features and get further support? =
  • gravity-zwr/trunk/readme.txt

    r3266575 r3267953  
    1212
    1313== Description ==
    14 
    1514This plugin adds a "Zoom Registration" feed to your Gravity Forms. Although it was created specifically for the Webinars feature on Zoom, it will also work with regular Meetings.
    1615
     
    2019
    2120== Requirements ==
    22 
    23211. A WordPress.org based website
    24222. The [Gravity Forms](https://www.gravityforms.com/) plugin
     
    3028
    3129== Third-Party Services ==
    32 
    3330This plugin integrates with the Zoom API to facilitate registration for webinars and meetings. By using this plugin, you acknowledge that certain data will be transmitted to Zoom in order to create and manage webinar registrants.
    3431
     
    4340For any concerns regarding data transmission and processing, please refer to the links above to understand how your information is handled by Zoom.
    4441
    45 
    4642== Installation ==
    47 
    48431. Install the plugin from your website's plugin directory, or upload the plugin to your plugins folder.
    49442. Activate it.
     
    5247
    5348== Usage ==
    54 
    55491. After installation, go to **Gravity Forms > Settings > Zoom Webinar**. Enter your [Server OAuth App](https://marketplace.zoom.us/docs/guides/build/server-to-server-oauth-app/) Account ID, Client ID, and Client Secret. These apps are free to create, take only 5 minutes, and don't need to be published. Fill in all three fields and hit Save.
    56502. Follow the directions on the Zoom API docs carefully. You’ll need to edit roles in Zoom settings and create the app. Your user role and app must have the `meeting:write:admin` and `webinar:write:admin` scopes. If you are having issues, you may need to add the following scopes: `meeting:write:registrant:admin` and `meeting:read:list_meetings:admin`.
     
    6256
    6357== Constants ==
    64 
    6558By default, this plugin will ask for your Account ID, Client ID & Secret in the Gravity Forms settings. Users wanting more control can specify these as constants: `GRAVITYZWR_ACCOUNT_ID`, `GRAVITYZWR_CLIENT_ID`, and `GRAVITYZWR_CLIENT_SECRET`.
    6659
    6760== Payments ==
    68 
    6961This add-on supports delayed payment through the Gravity Forms PayPal add-on. Charge for registrations via PayPal, processing the Zoom Registration feed only upon successful payment. [Read more here.](https://docs.gravityforms.com/setting-up-paypal-payments-standard/)
    7062
    71 == Retrieving Join Link URL ==
    72 
    73 Starting from version 1.4, a Join Link field has been added to the Zoom Webinar feed registation fields section. If you want the join link to populate into a hidden field on the entry, then just choose the field you want from your form.
    74 
    7563== Migrating from Old Plugin ==
    76 
    7764This plugin uses the same text domain as the other one by Michael Bourne, so all of the settings and webinar feeds that you previously set up will remain. All you need to do is install and activate this plugin while the other one is activated. No need to set everything up again. :)
    7865
    79 == Mapping Custom Questions == 
     66== Frequently Asked Questions ==
     67= The registration did not go through, what happened? =
     68There could be several reasons. You can check for an error in the entry details notes, which should give you a good indication of what happened. Some common reasons include:
     69* You didn't actually set up the plugin or a webinar/meeting feed
     70* The Account ID, Client ID, and/or Client Secret are incorrect
     71* Incorrect scopes set
     72* A field is required on your Zoom registration form but not mapped on the plugin feed
     73* The webinar or meeting with the ID you entered does not exist
     74* The feed is set to a webinar when it should be a meeting or vice versa
     75* The webinar/meeting host can not register
     76* User's email cannot register for the same webinar/meeting more than 3 times in 24 hours
    8077
    81 Starting from version 1.4, you can map custom questions to your Zoom registration by using a simple code snippet in your website’s theme. This allows you to include additional fields beyond the default ones.
     78= How do I retrieve the join link URL after registration? =
     79A Join Link field has been added to the Zoom Webinar feed registation fields section. If you want the join link to populate into a hidden field on the entry, then just choose the field you want from your form.
    8280
    83 To do this, you’ll need to add a small piece of code to your theme’s `functions.php` file. In the example below, we’re adding a custom question called “Referral Source.” The **name** in the code must exactly match the field name used in your Zoom registration.
    84 
    85 Here’s the code you need to add:
     81= How do I map custom questions? =
     82You can map custom questions to your Zoom registration by using a simple code snippet in your website’s theme. This allows you to include additional fields beyond the default ones. To do this, you’ll need to add a small piece of code to your theme’s `functions.php` file. In the example below, we’re adding a custom question called “Referral Source.” The **name** in the code must exactly match the field name used in your Zoom registration. Once this is added, the “Referral Source” field will be included in your Gravity Forms Zoom Webinar feed settings. Here’s the code you need to add:
    8683
    8784`add_filter( 'gravityzwr_registration_fields', function( $fields ) { 
     
    9289    ]; 
    9390    return $fields; 
    94 } );` 
    95 
    96 Once this is added, the “Referral Source” field will be included in your Gravity Forms Zoom Webinar feed settings.
    97 
    98 == Support ==
     91} );`
    9992
    10093= Where can I request features and get further support? =
Note: See TracChangeset for help on using the changeset viewer.