How to install the WPHelpDesk Ninja Forms Integration plugin
As a minimum requirement, you need WPHelpDesk version 1.2.10 (or higher) installed. If you are not on that (or a higher) version, please update WPHelpDesk before continuing. The add-on will work with Ninja Forms version 3.3.7 and above. Although it will work with some older versions as well, it is always advised to use the latest version.
The WPHelpDesk Ninja Forms integration plugin can be installed like any other WordPress plugin. Download the plugin file from your account, and follow these steps:
- In your WordPress admin page, visit the Plugins page, click the Add New button, and then the Upload Plugin button.
- Choose the file you downloaded (it should be named wphelpdesk-nf-x.y.z.zip, where x.y.z will be the current version, e.g. wphelpdesk-nf-1.0.0.zip) and click Install Now.
- After the installation is complete, locate the plugin in the list (it will be named “WPHelpDesk Ninja Forms Integration”) and click Activate.
- Visit the WPHelpDesk License page (Helpdesk -> License), enter your relevant license key in the “Ninja Forms” section, and click the Activate License button next to it. This will ensure that you will receive updates.
How to configure Ninja Forms to submit tickets to WPHelpDesk
Step 1 – Enable the integration
From the Ninja Forms interface, either create a new form or edit an existing one. Click on the Advanced tab, then on Display Settings, and expand the Advanced section at the right of the screen.
Then, scroll down at the bottom of the Advanced section, locate the “WPHelpDesk Ticket Form” option, and enable it.
Step 2 – Map the fields
The next step is to associate the fields on your form to the relevant fields in WPHelpDesk to make sure that all relevant details will end up in the ticket that will be created after the form submission.
As a minimum requirement, your form needs to include the following four fields:
These can be labelled in any way you want (e.g. “Name” can be called “Your name”), that will not affect the ability to map them to WPHelpDesk.
Please note that all four fields need to be mapped to their respective fields in WPHelpDesk, otherwise the ticket will not be created.
To map a field, click on it to open its settings, then expand the WPHelpDesk section and select the WPHelpDesk field you want to associate it with.
In the example above, the “Name” field is mapped against the “Your Name” field in WPHelpDesk.
Please make sure that you enable the “Required Field” option for all fields that are required by WPHelpDesk, to ensure that they are filled by the user, otherwise if any of them is missing a value the ticket will not be created.
Note that we do not currently support file attachments through Ninja Forms.
Apart from the four required fields, any custom fields you have created in WPHelpDesk will also appear here.
Mapping text-based custom fields is very straightforward. In the example above, the Phone field of the form is mapped to the Phone custom field in WPHelpDesk.
It is possible to map Dropdown custom fields too. As an example, we will map the custom field depicted above. In this example, the custom field has three options:
- Low (Value: 1)
- Medium (Value 2)
- High (Value 3)
In your form, add a Select field, and click to edit it. You need to include manually the same amount of options as the custom field in WPHelpDesk, making sure that their values match to the ones of the custom field. As with every other field, their labels could be different.
So, for example, if the user selects the third option (Extremely Urgent) which has the value of 3, in the ticket, the Urgency custom field will display the option “High” as selected, which also has the value of 3.
Fields without mapping
Not all of the fields are required to be mapped to WPHelpDesk. Any unassigned field will still be processed by Ninja Forms and will be stored in the form submission (assuming that you have enabled that option in the Emails & Actions section), but it will not appear in the WPHelpDesk ticket.
In the example above, the Address field is not mapped to any WPHelpDesk field; the [No Assignment] option is selected.
Step 3 – Decide how to handle email notifications
By default, WPHelpDesk will not send any email notifications for the tickets created via Ninja Forms, since usually the form is configured to send notifications itself.
If you wish to let WPHelpDesk handle the email notifications instead, first visit the Emails & Actions section of your form and make sure that you disable both the “Email Confirmation” and the “Email Notification” options.
Then, visit WPHelpDesk’s configuration page (Helpdesk -> Config) and locate the section related to Ninja Forms (see screenshot above). There, you can enable any of the options related to email notifications.
You can also choose to create an account for every user (if they don’t have one already).
Using the Ninja Forms Integration and Inbox add-on at the same time
If you configure Ninja Forms to send an email of with the submitted form to an admin and you are using the Inbox add-on (which enables Email Piping) to import email messages as tickets, then please make sure that the emails sent from Ninja Forms are not being sent to the same email Inbox is importing emails from or make sure that they land to folder other than the one Inbox is configured to import emails from, to ensure that emails sent from Ninja Forms won’t be imported as new tickets.
How tickets created via Ninja Forms will look like
Tickets that were created via Ninja Forms will look and act as regular tickets created via the [submit_ticket] shortcode. You will be able to identify that a ticket have been originally submitted via Ninja Forms via the different icon depicted below.