All guides
Integrations

Put a lead form on your website

Paste your ViveLead lead form into any website with one embed code, so every enquiry lands in Leads. If your site already has its own form, send it to the Lead Capture API instead.

This puts your lead form on your website, so every enquiry arrives in ViveLead as a lead without anyone copying it across. The embed takes about five minutes and needs no developer.

Before you start

  • Your role needs the Form Update permission. If Forms Desk is missing from your menu, ask your admin to switch it on for your role under Users, then Roles.
  • The embed works on every plan. The Lead Capture API, covered at the end, is on the Professional plan and above. See pricing.
  • You need to be able to edit your website, or have someone who can paste a piece of HTML into it.

Steps

  1. Open Controls, then Forms Desk in the left sidebar. The Forms tab opens. In the form picker at the top, choose Lead Form.

  2. Pick the fields your visitors fill in. Click the pencil icon on a field to open its settings, then tick Show on public form. Do this for every field you want on the website. Fields ticked Required must be filled before the form will submit. Click Save in the Unsaved changes bar at the bottom. The bar disappears once the change is saved.

    Forms Desk with Lead Form chosen. Outlined: Forms Desk in the sidebar, the pencil icon on the Email field, Show on public form ticked on the opened PhoneNumber field, and Save in the Unsaved changes bar

  3. Click Share, then Enable public sharing. Share sits next to Add Field at the top of the form. The Share Form dialog opens. Once sharing is on, it shows Public sharing is live with two tabs, Link & QR and Embed.

    The Share button, outlined, next to Add Field above the Lead Form

    The Share Form dialog for the Lead Form with the Enable public sharing button outlined

  4. Open the Embed tab and copy the code. Leave Allow embedding switched on. Click the copy button beside Embed Code. Live Preview below it shows the form your visitors will see.

    The Share Form dialog showing Public sharing is live. Outlined: the Embed tab and the copy button on the Embed Code box. Allow embedding is switched on and a live preview of the form sits below

  5. Paste the code into your website where the form should appear. It is one line of HTML. In WordPress, add a Custom HTML block and paste it there. On other site builders, use their HTML or embed element. The code sets the form to 600 pixels tall. If your form has more fields and shows its own scrollbar, change height="600" to a larger number.

    A Contact us page on a website with the embedded lead form showing Name, Email and PhoneNumber fields and a Submit button

  6. Send a test enquiry from your website. The form switches to a Thank you screen.

    The embedded form on the website showing Thank you after the enquiry was sent

    The enquiry appears in Leads as a new lead with the source PUBLIC_FORM.

    The Leads list with the new lead Riya Sharma at the top and PUBLIC_FORM outlined in its Source column

The Link & QR tab has the same form as a link and a QR code, for places where you cannot paste code, such as a social bio, an email or a poster.

The Link & QR tab showing Public sharing is live, the public URL with a copy button, and a QR code with a Download PNG button

When the person is already a lead

If the phone number matches a lead you already have, no second lead is created. The same goes for the email if you have ticked Primary on the email field. The existing lead gets any empty fields filled from the form, and its timeline shows Submitted a public form, at most once a day. The visitor sees the same Thank you screen either way.

To have every submission arrive as a new lead, untick Primary on both the phone number and email fields in Forms Desk, then click Save.

Keep your own website form instead

If your website already has a form your developer built, send its entries to the Lead Capture API rather than embedding ours. This part needs a developer, and the Professional plan or above.

  1. Open Marketing, then Integrations. On the Lead Capture API card, click Generate. The card now shows Active.

    The Integrations page. Outlined: Integrations in the sidebar and the Generate button on the Lead Capture API card, which shows Not Generated

  2. Click View Integration Guide. The API Docs tab shows your key, the endpoint, a sample request and every field. Send Test Lead adds a lead named Test Lead (API) with the source API Test, so you can watch one arrive. Delete it afterwards.

    The API Docs tab with the API key hidden. Outlined: the Endpoint and the Send Test Lead button. The x-api-key header, a sample request and the list of fields are also shown

  3. Have your developer send each enquiry from your website’s server.

    POST https://api.backend.net.in/api/public/lead/capture
    x-api-key: YOUR_API_KEY
    Content-Type: application/json
    
    {
      "name": "John Doe",
      "phoneNumber": "9876543210",
      "email": "john@example.com",
      "source": "Website"
    }
    

    name is required. Send phoneNumber, email, or both. countryCode defaults to +91. notes and customFields (any extra key-value pairs) are optional.

Three things your developer should know:

  • Call the API from the server, never from JavaScript in the page. Anything in a web page can be read by its visitors, and this key can also change your existing leads. If the key ever shows up in a page, click Regenerate on the card and put the new key on your server. The old key stops working at once.
  • A new lead comes back with its leadId. A person who is already a lead comes back as 409 with that lead’s leadId. Their empty fields are still filled, and the contact is logged on their timeline, at most once a day.
  • One key takes 200 requests an hour.

If it does not work

What you seeWhat it meansWhat to do
Enable public sharing is greyed out, with “No fields are marked as public yet”No field has Show on public form tickedTick it on the fields you want, click Save, then open Share again
The form on your site says “Form not found”The link was regenerated, which retires the old codeOpen Share, then Embed, copy the new code and replace the old one on your site
The form on your site says “This form is no longer accepting submissions”Public sharing was disabled, or no saved field is ticked Show on public formOpen Share and click Enable public sharing. The link stays the same, so the code on your site works again
A scrollbar appears inside the formThe form is taller than 600 pixelsRaise the height="600" value in the code
The API answers “The lead capture API is not included in your current plan”Your plan does not include the APIMove to Professional, or use the embed above, which works on every plan
The API answers “Invalid API key”The key was regenerated, or was copied wronglyCopy the key again from the API Docs tab
The API answers “Send a phoneNumber or an email”The request carried neitherSend at least one of them
Send Test Lead says “Lead with this phone number already exists”The test lead from an earlier click is still in LeadsDelete Test Lead (API) from Leads, then try again

Still stuck on this step?

Send us what you are seeing and we will sort it out with you.