All Collections
Leads & Customer Portal
Can I capture leads for Buildxact from my website?
Can I capture leads for Buildxact from my website?

This guide shows how your website can be set up with a form to capture lead details which then pass to your Buildxact account.

Matt Govett avatar
Written by Matt Govett
Updated over a week ago

Note: if you used a website developer to set up your website, they will be able to use the following steps to complete a lead capture form.

Steps to build a lead capture form for your website using the Buildxact API:

  1. Sign up and get API access

    1. Go to the Buildxact API website ( and sign up for a developer account to get API access.

    2. Obtain the API key or token provided for authentication.

  2. Design your lead capture form

    1. Decide on the lead details you want to capture. All possible fields can be found here: (

    2. Design a simple form on your website with a separate field for each lead detail.

  3. Handle form submission

    1. Implement a way to handle form submissions for when users enter their lead details and click submit.

  4. Send data to the server

    1. Use JavaScript to send the lead details entered in the form to your website's back-end server.

  5. Set up your back-end server

    1. If you don't have a back-end server, set one up using a server-side programming language (e.g., Node.js, Python).

  6. Authenticate API requests

    1. In your back-end server, include the API key or token in the requests to authenticate with the Buildxact API.

    2. Authentication specifics can be found here (

  7. Handle API integration

    1. Use the Buildxact API documentation ( to understand required details for creating a lead.

    2. Before creating a lead, you need a Customer and subsequently a CustomerContact record to create a lead via the POST method .

      1. Firstly you need to create your Customer/Client -

      2. CustomerContact - With customer created from the previous step, you'll want to include the CustomerID as part of the request to{id}/contacts

    3. Make a request from your back end to the Buildxact API with the lead details received from the form.

  8. Process API response

    1. Handle the response from the Buildxact API in your back end to see if the lead was successfully created, OR,

    2. Store the lead details in your back-end server for future reference.

  9. Provide user feedback

    1. Send a response from your back end to the front-end to let users know if the lead was successfully captured or if there was an error.

  10. Test your lead capture form

    1. Test the lead capture form and API integration to ensure everything works as expected.

Important Note

Please ensure that your API credentials are kept secure and not shared publicly.

Remember to refer to the official Buildxact API documentation for any specific details and requirements for lead capture and API integration.

Good luck with building your lead capture form!

Did this answer your question?