Vimeo Uploader

The Vimeo Uploader add-on needs to be installed and activated to see the features mentioned in this this documentation.

vimeo-uploader

Get the Plugin: 

The Ninja Forms – Vimeo Uploader extension is available at the Ninja Forms marketplace.

How to Setup:

In order to connect your Vimeo account to your WordPress site, you’ll need to obtain an access token that securely establishes this connection.
You can retrieve an access token for your Vimeo account through the Vimeography Upload app HERE, which will prompt you will an opt-in authorization screen.

1-vimeo-authorize

Once you have authorized access to your Vimeo account through the link above, your access token will be displayed on the screen. Your access token is similar to a password for your Vimeo account, so be sure to protect it and don’t give it out to anyone.

2-vimeo-token

  • To give the Vimeo Uploader extension access to your Vimeo account, select your access token and copy it to your clipboard.
  • Now, head over to your WordPress Dashboard and visit the Forms > Settings page in your admin menu.
  • Scroll down until you see the Vimeo Uploader Settings box, which contains a text field with a Vimeo Access Token label.
  • Paste your access token in this field and then click the blue Save Settings button at the bottom of the page, as shown below.
  • Your Vimeo account is now successfully connected!
3-vimeo-uploader-settings-token

Adding Uploader fields to your Form:

Start by heading to your WordPress Dashboard and visit the Forms > Add New page in your admin menu.
You’ll be presented with the Ninja Forms form builder. Under the Form Fields heading, click the blue plus (+) that allows you to add your own form fields.
Scroll to the bottom of the Form Fields drawer to find the Vimeo Uploader section. You should see three fields available to you:
4-vimeo-drawer-example
  • Video Title is a text box that allows your site visitor to enter a title for the video that they are uploading.
  • Video Description is a text area that allows your site visitor to enter a description for the video that they are uploading.
  • Video Dropzone is a special field that allows your site visitor to drag and drop their video file into a box that will attach their video to the form. It also provides a link for the user to click and choose the video file on their computer as an alternate method of attaching their video to the form.
Let’s use all three of these fields in our video uploader form. You can add them to your form by clicking the navy button for each one.
You’ll also want to add a Submit button, so scroll to find the Common Fields section of the drawer, and click the navy button labeled Submit.
 5-vimeo-submit
Now that you’ve added these four fields to your form, click Done and let’s move on!

Using the Upload to Vimeo action:

Now that we have our form fields set up, it’s time to tell our form how to handle a video that a user attempts to upload.
From your form builder, click on the Emails & Actions tab at the top of the page. Then click the blue plus (+) button at the bottom right to add a new action to your form.
Now, under the Installed heading, select the Upload to Vimeo action to add it to your form.
 6-vimeo-upload
The Upload to Vimeo action currently has 5 settings:
  • Final Video Title allows you to make modifications to the video title that is being uploaded before it gets stored on Vimeo. The default behavior is to use the video title provided when the form was submitted.
  • Final Video Description allows you to make modifications to the video description that is being uploaded before it gets stored on Vimeo. The default behavior is to use the video title provided when the form was submitted.
  • Minimum User Role for Uploading allows you to select the minimum WordPress role that your site visitors must have in order to upload videos to your Vimeo account. If you would like for all visitors to have uploading permission, choose Guests+
  • Video Privacy allows you to set the default privacy setting of the uploaded video once it is stored on your Vimeo account. The default setting Only Me will hide your video from the public.
  • Add Uploaded Videos to a Vimeo Collection [toggle] allows you to enter the URL of a Vimeo group, album, or channel that you would like to add the uploaded video into. You must be the owner of the group, album, or channel for this setting to work properly.
Now that you’ve learned about these settings, click Done and let’s move on!

Displaying the Vimeo Link on the Success Page:

Lastly, to show the Vimeo URL link for the video that was just uploaded on the form success page, you can simply use the [ninja_forms_vimeo_link] shortcode in the Emails & Actions > Success Message‘s message box shown below, or use the {vimeo_uploader:vimeo_url} merge tag. This will output a link to the new video where it is housed on Vimeo, for the user to verify upon form completion.

7-vimeo-success-message