Connecting Ninja Forms to PipelineDeals
To connect to your PipelineDeals account, you’ll need only your API key.
You’ll enter this into the text box found in the PipelineDeals Section of the Ninja Forms Settings as shown here:
Upon entering in your API key, scroll to the bottom and click “Save Settings”.
After saving your settings, click on the link named “Click to test your API connection.” If you’ve entered valid connection settings, then you’ll now see a successful connection message in the Communication Summary. If you aren’t successful here, chances are your API key isn’t correct.
NOTE: Remember this dashboard section well – any time in the process you need help, this Communication Summary will display the most recent status and can not only help you, it can help our awesome Support Staff help you faster!
Importing Custom Fields from PipelineDeals
If you have custom fields you intend to use click on the “Refresh your Account Data” link.
This will import this account data into the extension for your use later on.
You’ll see in the Account Data a list of all the custom fields available for your use along with some other useful information. This additional information includes the type of field and a number ID for each one; this information will come in handy when we get to that step in the process.
Mapping Form Fields to PipelineDeals
Once you are successfully connected to your PipelineDeals account, you can now point all your form fields to where you’d like them to end up in PipelineDeals.
Create Your ‘Add to PipelineDeals Action’
After you’ve created your Ninja Form, go to the Emails & Actions tab. There you will see a button called “Add to PipelineDeals” (arrow #1). Click this button and you will now have an Add to PipelineDeals action added to your form as shown by arrow #2. Finally, click on the action settings (arrow #3) to start mapping your fields.
Map Your Fields
Field mapping is the process of telling Ninja Forms which information you want to send to PipelineDeals and where in PipelineDeals you’d like it to go.
The field map has two columns – Form Field and PipelineDeals Field as shown in the following screenshot. To add a new field map entry, click on the “Add New” button.
The Form Field text box specify the value from your form to use. You can use the Ninja Forms merge tags to easily specify the field value to use.
The PipelineDeals Field is a drop-down list of all the available locations in PipelineDeals where you can send the data. If your PipelineDeals account uses custom fields, these fields will appear here if you have refreshed your account data on the setting page.
It is helpful to have your form design fairly complete before starting the field map but you can add or remove form fields at any time and then modify this field map to suit. When done with your field map, click “DONE” and then save your form.
Create a New Person
To create a new person begin by mapping form fields to First Name and Last Name. After that, you can then add whatever other details from your form go with the person, such as contact information.
Create a New Company
To create a new company begin by mapping form fields to Company Name. After that, you can then add whatever other details from your form go with the company. Your newly created company will be auto-magically connected to the person that gets created.
Create a Deal, Task, and Note
You can create a new deal, task, and note all linked to the new person by populating the Deal, Task, and Note fields in your field map. Using the dropdown for PipelineDeals fields, you can see all the available fields.
Note: Not all Form Field values have to come from the form user – if you want a specific value set for a PipelineDeals field, you can simply type that value in the Form Field box. This enables you to have a standard process and naming convention for your sales team rather than relying on the form submitter to name everything through the form. In the following example, see #1.
Note: Dates do not have to be specific values – you can specify a date to be calculated relative to the date of the form submission. In this example, the task due date is set for “1 week”, which the plugin will then calculate and set for you (#2).
Mapping a form field to your PipelineDeals custom field follows the same process as standard fields. You will see your custom fields appear at the bottom of the PipelineDeals dropdown list.
If your custom field in PipelineDeals is a dropdown list, which means it allows only certain, pre-specified values, you have one additional step to ensure only the allowed values will be sent by your form.
First, visit your Ninja Forms PipelineDeals settings section to see which custom fields have pre-specified field options. In this example, the “Product Interest” custom field allows for either “Kitchen,” “Bathroom,” or “Deck.” Next to each option is a number ID; this ID is the value that has to be sent.
To send that value, your form will need one of Ninja Forms easy-to-use multiple selection fields, like “Checkbox List,” “Select,” “Radio List,” or “Multi-Select.” This four form field types enable you to create a selection list from which the form user can pick their response. Add your options by putting the text you wish to display as the label and use the number ID as the value.
Note that in this example the three option labels and their corresponding values match the labels and number IDs from the PipelineDeals setting section above.
Your custom field with pre-specified responses is now ready to submit to PipelineDeals.
After you have finished mapping all your fields, click ‘DONE’ and finish by saving your form. One final step will be to test your form to ensure it sends data to PipelineDeals as intended, and the best way to do it is to fill out your form and submit it.
After submitting your form, visit the PipelineDeals section of the Ninja Forms Settings page. Here, you’ll see a communication summary. If your form successfully submitted, you’ll see a message saying “Successfully created at: “ along with the time.
Note that it is possible for some entries to be create but not all of them. For example, you can create a perfect new Person entry, but if there is a mistake in your PipelineDeals field map, the deal won’t be created.
If you see an error for every entry, don’t worry – this will happen if there is an error with your new Person because if that fails, the other entries, however perfect they may be, won’t be able to attach to the Person. Thus, when troubleshooting, start at the first entry that is on the Communication Summary list and work your way down.
The Communication Status will guide you to solving why PipelineDeals rejected the request. Remember that you’ve already successfully communicated with PipelineDeals during set up so we know that your communication works and now it is just a process of ensuring your form data matches PipelineDeals’ requirements.
Sometimes, you may not be able to figure out the issue on your own and you may feel the need to submit a support request. To help with this, we’ve built in some advanced diagnostics that will help identify the issue faster. Go to the Advanced Commands text box below the Communication Summary and type in the word support, then click Save Settings, then refresh your browser screen.
Here is an example of the Advanced Commands textbox with the support data command.
After refreshing your browser screen, you will see the:
- Submission Data
- Structured Array
- Formatted Request
- Full Response
Simply take a screenshot that includes these four areas and include it in your request. This information quite regularly is all we’ll need to help solve your field map issue and get you on your way!
Here’s a partial sample of the support data:
The Advanced Commands text box enables a non-developer to do some customized, more advanced commands without needing a developer. You will type in the commands you want to use, separating each with a comma, and the plugin will do the rest.
Here is a list of the supported advanced commands for use with PipelineDeals:
- Display the diagnostic data on a form submission. Use this when requesting support as it helps us identify and field mapping issues as quickly as practical.
- Text area boxes have html tags that are removed with code by default. If you do not wish to remove html tags before sending, add this command.