Edgewise Docs
Edgewise Docs

©2024 Edgewise Technologies

Lead Registration

You can always manually enter a new lead within Seller Central, but most times a lead is automatically added for you through interactions a user has with your project. There are eight ways a lead can be created:

  • Manually in Seller Central
  • Emailing the project's Edgewise email address
  • HTML form
  • Edgewise Components
  • Edgewise SDK (JS, PHP)
  • Edgewise GraphQL API
  • Integrations (eg, DocuSign, Calendly, Avochato, etc.)
  • Hosted registration page

Manual Entry

image

In Seller Central, navigate to the Leads page, and click "New Lead". Each lead is assigned to a project. You can set the lead's contact info, sources, assignment, address, etc..

Once created, you can add additional information like preferences, tags, agent, etc..

Emailing the project's Edgewise email address

Every project in Edgewise has an email address, based on a URL friendly version of the project's title (aka a "slug"). For example, a project title of "Acme Condos" would have an email address of:

acme-condos@inbox.edgewiserealty.com

When Edgewise receives an email to this address, the message will either create a new lead, or merge with an existing one based on the email address of the sender.

HTML Form

It is common for a project's marketing website to have contact forms. Using traditional HTML forms (no javascript needed), you can simply post the form to Edgewise. All projects post to the same URL:

https://api.edgewiserealty.com/form-handlers/contact-project

The supported form values that can be submitted are essentially the same as the supported values for the contactProject API call; with a few minor exceptions:

  1. HTML forms do not support nested properties, so you need to flatten those values. For example, if you want to set the zip code of the lead, you would set the input field's name to address[postalCode]. To assign a custom metadata field to a lead, you would set the input field's name to metadata[foo].
  2. HTML forms do not support arrays (lists), but lists can be created by joining via a comma. For example, if you want to assign multiple tags to a lead, you would set the "tags" value to "foo,bar".

The default source for a lead that comes in through an HTML form is MESSAGE, but this can be explicitly set by passing one of the allowed sources.

In addition to the fields supported by the contactProject API call, there are two additional fields: successUrl and errorUrl. As you might imagine, these are redirect URLs that will be called in the event of success or error. For instance, you might redirect the user to a thank you or confirmation page on success. If successUrl is not set, the user will be returned to the calling page (referrer).

Example

<form action="https://api.edgewiserealty.com/form-handlers/contact-project" method="post">
  <!-- REQUIRED -->
  <input type="hidden" name="projectId" value="8">
  <input type="text" name="email" value="peter@dailybugle.com">
  <input type="text" name="name" value="Peter Parker">

  <!-- OPTIONAL -->
  <input type="text" name="text" value="Hi, I'm interested in ...">
  <input type="text" name="phone" value="(555) 555-5555">
  <input type="text" name="isAgent" value="true">

  <!-- NICE-TO-HAVES -->
  <input type="text" name="address[postalCode]" value="12345">
  <input type="text" name="preferences[bedrooms]" value="BD_3">
  <input type="text" name="source" value="PAID_SEARCH">
  <input type="text" name="metadata[nickname]" value="Spiderman">
  <input type="text" name="tags" value="foo,bar">

  <!-- TRACKING -->
  <input type="hidden" name="utm[campaign]" value="Effective Campaign">

  <!-- REDIRECTS -->
  <input type="hidden" name="successUrl" value="https://google.com">
  <input type="hidden" name="errorUrl" value="https://bing.com">
</form>

Testing

To test the values being sent to Edgewise without creating / merging leads, you can add a "debug=true" query parameter. This will return the parsed values in JSON. Note, this does not validate the data.

Edgewise Components

Edgewise Web Components are copy / paste code snippets for quickly embedding Edgewise functionality in a website. They are configurable, and stylable via CSS variables.

Learn more about Edgewise Components

Example

<script src="https://libs.edgewise.cloud/components@1"></script>
<ewc-project-contact-form project-id="ID_OR_SLUG_GOES_HERE">
</ewc-project-contact-form>

Options

Additional options include the ability to assign default values, debugging, and the ability to listen for events via javascript (e.g. on submit). Reach out to support@edgewiserealty.com with any questions.

Edgewise SDK

Edgewise offers two SDKs (PHP and JS) that reduce the amount of work required to use the Edgewise GraphQL API. Both require an API access token.

See SDK

Edgewise GraphQL API

The Edgewise API offers full control, but is also the most labor intensive. Edgewise is built "API first", so almost all functionality is exposed via the API.

Learn more about the Edgewise API

Integrations

Edgewise has built-in support for 3rd party integrations. These are as simple as entering your credentials in Edgewise (or giving consent), and then configuring. No need to get your hands dirty with respective APIs.

Hosted Registration Page

Every project has hosted lead registration page by default. This page is hosted on the Edgewise Marketplace. It is mobile and tablet friendly.

Paired with our QR code feature, use the hosted registration page for walk-in registration.

Learn more about Hosted Registration Pages.

Table of Contents