developers API Documentation

PipelineDeals provides a very easy way of creating leads from a web site form. PipelineDeals will process a form that sits on your website and redirect the user to a thank you page that you provide when they hit the submit button.

Setting up the form

Setting up your form requires you to simply ensure that you are using the correct field names that PipelineDeals is looking for.

PipelineDeals will process the form, then redirect the user back to a thank you page of your choosing.

To ensure that PipelineDeals processes your form correctly, you'll need to set your <form> tag correctly.

<form method="post" action="https://www.pipelinedeals.com/web_lead">
...
</form>

Inside your form, please follow the naming conventions supplied in the table below.

Developer Mode

For Web-to-Leads, you can turn on developer mode to ensure that your web form will work correctly and is free of errors.

To enable developer mode, insert the following code inside your form:

<input type="hidden" name="developer_mode" value="true">

PipelineDeals Naming Conventions

Name	Required?	Default	Description
developer_mode	No	false	developer_mode is useful to turn on when you are creating your form. When you submit the form, it will take you to a special page that will list information, like whether the lead is valid, your w2lid, if the lead passed the spam test, etc.
thank_you_page	No	the referring URL	thank_you_page is the full URL of your thank you page after the user submits the form. It is not necessarily required, but definitely recommended. If you do not fill out a thank_you_page (and developer_mode is off, PipelineDeals will redirect the user back to the referring URL.
w2lid	YES	None	This is your w2lid that you can find in Admin -> Web to Leads. It is used to uniquely identify the user to use when using Web-to-Leads. Important Note: The w2lid is required. If you do not provide a w2lid and developer_mode is turned off, we will refer you back with ?invalid_w2lid=true. Otherwise you will see the error if developer mode is on.
assign_to_id	No	the user who owns the w2lid	Assign this lead to a specific user in your account. You can find user ids here.
use_spam_filter	No	false	Filter your web leads through our commercial spam filter. If the lead is spam, it will not be delivered into your PipelineDeals account. To use the spam filter, set this directive to true.
todo_template	No	the name of a todo template to apply	Apply this lead template to the new lead. If the template does not match any of your todo templates, it is ignored.
lead[lead_source]	No	"Web to Lead"	The lead source name of this lead. If not set, it will default to "Web to Lead".
lead[lead_status]	No	None	The lead status name of this lead. If not set, it will default to None. The lead status names can be viewed or set in Admin -> Lead Statuses.
lead[last_name]	YES	"None provided"	The last name of the incoming lead.
lead[full_name]	No	None	If you set this, PipelineDeals will try to parse the user's full name (firstname lastname)
lead[first_name]	No	None	The first name of the incoming lead.
lead[position]	No	None	The position (job title) of the incoming lead.
lead[phone]	No	None	The primary phone number of the incoming lead.
lead[fax]	No	None	The fax number of the incoming lead.
lead[email]	No	None	The primary email address of the incoming lead.
lead[home_address_1]	No	None
lead[home_address_2]	No	None
lead[home_city]	No	None
lead[home_state]	No	None
lead[home_postal_code]	No	None
lead[home_country]	No	None
lead[home_email]	No	None
lead[home_phone]	No	None
lead[work_address_1]	No	None
lead[work_address_2]	No	None
lead[work_city]	No	None
lead[work_state]	No	None
lead[work_postal_code]	No	None
lead[work_country]	No	None
lead[mobile]	No	None	The mobile phone # of the lead.
lead[company_name]	No	None	The company name of the lead.
lead[website]	No	None	The lead's website

Using tags

You can also use tags with the incoming leads to further slice and dice them. You may use up to 10 tags in the form.

Ensure your tags match up with amdin predefined tags. If a tag has been added that is not part of the admin predefined tags, it will be created as an admin predefined tag. Because of this, ensure that you do not leave tags open to any user input.

Simply name the input field tag_<n>, where n is the tag number.

An example of using a tag would be to allow the lead to select a potential product they are interested in.

<select name="tag_1">
  <option value="product1">Product 1</option>
  <option value="product2">Product 2</option>
</select>

Or you can simply add a static tag all the time.

<input type="hidden" name="tag_2" value="Auto Parts"/>

Using notes

You can have up to 10 text areas that will be appended to the lead as notes.

you can set the title of each note by having a hidden field that denotes the note title

<input type="hidden" name="note_title_1" value="How did you hear about us?" />
<textarea name="note_1"></textarea>

SSL

Although you can call www.pipelinedeals.com/web_lead in non-SSL mode (using http:// instead of https://), it is recommended that you always call the https:// version of the site.

If your form is SSL-enabled and you call the non-SSL version of the site, the user will see a warning when they submit the form.

Form Validation

PipelineDeals does not do any type of form validation. It is up to you to make sure the user fills out all the fields you wish to require.

Lead Assignment

PipelineDeals will automatically assign leads to your teammates using a round-robin method. The w2lid is user-based, so be sure to use the w2lid of a manager if you want to have the leads round robin to the manager's team. If the user provided does not have a team, the leads will be assigned to that user.

A Simple Example:

<html>
  <form method="post" action="https://www.pipelinedeals.com/web_lead">

    <input type="hidden" name="w2lid" value="334lkn43kn5" />
    <input type="hidden" name="thank_you_page" value="http://website.com/thankyou.html" />

    <!-- Basic Demographic Fields -->
    <p><label>Name</label><br/>
    <input type="text" name="lead[full_name]"></p>
    <p><label>Company</label><br/>
    <input type="text" name="lead[company_name]"></p>
    <p><label>Phone</label><br/>
    <input type="text" name="lead[phone]"></p>
    <input type="text" name="lead[fax]"></p>
    <p><label>Email Address</label><br/>
    <input type="text" name="lead[email]"></p>

    <!-- Comments Field -->
    <input type="hidden" name="note_title_1" value="User Comments" />
    <textarea name="note_1"></textarea>
  
    <input type="submit" value="save" />
  </form>
</html>

A More Complex Example:

<html>
  <form method="post" action="https://www.pipelinedeals.com/web_lead">

    <!-- Required Hidden Fields -->
    <input type="hidden" name="w2lid" value="334lkn43kn5" />
    <input type="hidden" name="thank_you_page" value="http://website.com/thankyou.html" />

    <!-- Basic Demographic Fields -->
    <p><label>Name</label><br/>
    <input type="text" name="lead[full_name]"></p>
    <p><label>Company</label><br/>
    <input type="text" name="lead[company_name]"></p>
    <p><label>Phone</label><br/>
    <input type="text" name="lead[phone]"></p>
    <input type="text" name="lead[fax]"></p>
    <p><label>Email Address</label><br/>
    <input type="text" name="lead[email]"></p>

    <!-- Tags -->
    <p><label>Product</label><br />

    <select name="tag_1">
      <option value="Widget A">Widget A</option>
      <option value="Widget B">Widget B</option>
    </select>

    <!-- Comments Field -->
    <input type="hidden" name="note_title_1" value="User Comments" />
    <textarea name="note_1"></textarea>
  
    <input type="submit" value="save" />
  </form>
</html>