Lead Intake Webhook and API

May 8, 2019 in Tutorials



Lead Intake Webhook and API

Aloware’s Lead Intake Webhook is a publicly available API endpoint that can receive Lead and Prospect data from other applications, forms, and services and add them as Contacts to your account. You can use Aloware Contacts as a data warehouse for your leads, segment them via tags or campaigns, or search for leads with specific attributes. Lead intake can also be configured for SMS automation, like sending an SMS to the lead when they submit a form.

Where is the API documentation?

You can view your API docs along with your account’s token (API Key) by going to Company menu and clicking on “API details”. The API key is unique to your user account on Aloware, meaning other Admin users have their own keys.

Is there an example I can use?

Yes. A cUrl example is copied below. Please contact us if you need assistance with implementation.

curl -X POST \
  https://app.aloware.com/api/v1/webhook/forms \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
    "api_token": "INSERT_TOKEN_HERE",
    "campaign_id": "1234",
    "phone_number": "8181234567",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@gmail.com",
    "date_of_birth": "MM/DD/YYYY",
    "timezone": "America/Los_Angeles",
    "city": "Los Angeles",
    "state": "CA",
    "zipcode": "90045",
    "country": "US",
    "notes": "This is a test note",
    "source": "web forms"
  }'

What are the possible fields I can send over?

Below is a descriptions of the intake fields supported by our Intake Webhook.

  • [campaign_id] Aloware campaign id (from campaign’s page) that this lead needs to be attached to. This field is required.
  • [phone_number] The lead’s phone number, in any format (8181234567, +18181234567, 818-123-4567, etc). This field is required.
  • [first_name] [last_name] Contact identifiers, optional.
  • [email] Contact identifier for CRM integrations, optional.
  • [date_of_birth] Contact’s birthday, in US format (12/05/1975 or 12-05-1975) for birthday campaigns, optional.
  • [timezone] Contact’s timezone for scheduling purposes, optional.
  • [city], [state], [zipcode], [country] Contact’s geographical location for segmentation, optional. If blank these values will be determined from the phone number.
  • [notes] Customer details on the Notes section of Aloware contacts. Use this field to capture your contact’s consent to electronic communications.
  • [source] A custom source field to segment the contacts later. optional.

What are the responses?

Aloware returns a HTTP 202 “Created” response on a successful call. Aloware returns the same status for duplicate contacts, since we handle duplicate entry removal on our backend.

# Returns an HTTP 202 response on success, Example success response:
{
    "message": "Contact created."
}

# Returns an HTTP 400 on failure with a detailed response, Example failure response:
{
    "message": "The given data was invalid.",
    "errors": {
        "phone_number": [
            "The phone number has already been taken."
        ]
    }
}

What should I do if I need to push custom data attributes, tags, or a large volume of data to Aloware?

If you need more API functions, please contact our support. We are happy to help.

Alternative Text


Supercharge Your Calls & Texts

Let us show you how we transformed the business phone.


Schedule a demo
WordPress Image Lightbox