Account Setup
To receive referral notifications from Baton via webhook, simply navigate to My Company > Notifications > Via Webhook settings.
Input the URL where you want the webhook to fire, along with username & password for authentication if you'd like.
If you don't see that option, message our team at client.success@batonleads.com).
What does the flow look like?
Create your profile and bid for referrals
Receive a webhook notification when other companies refer someone to you
Follow up with the lead (chances are they already called you), and get the deal
Fields
Here are the fields in the referral notifications:
Field Name | Field Type | Description |
payload_type | string | Indicates the format of the payload. |
wrap_in_array | string | Indicates whether the data should be wrapped in an array. |
unflatten | string | Indicates whether the data should be unflattened (i.e., converted from a flat structure to a nested structure). |
url | string | The URL of the endpoint that will receive the webhook. |
data | object | The data payload that will be sent to the endpoint. It contains the following fields: |
referral_id | string | A unique identifier for the referral. |
customer_name | string | The name of the customer who made the referral. |
customer_phone | integer | The phone number of the customer who made the referral. |
customer_email | string | The email address of the customer who made the referral. |
is_existing_customer | string | Indicates whether the customer who made the referral is an existing customer of the company. |
notes | string | Additional notes about the referral. |
specific_issue | string | The specific issue that the customer is experiencing. |
residential_or_commercial | string | Indicates whether the customer's property is residential or commercial. |
from_company | string | The name of the company that the referral came from. |
to_company_id | string | A unique identifier for the company that will receive the referral. |
to_service_area | string | The service area of the company that will receive the referral. |
bid | string | The amount of money that the company will pay for the referral. |
monetization_type | string | Indicates how the company will pay for the referral. |
zip_code | integer | The ZIP code of the customer who made the referral. |
first_name | string | The first name of the customer who made the referral. |
last_name | string | The last name of the customer who made the referral. |
headers | object | Additional headers to be included in the HTTP request. It contains the following fields: |
auth | string | An authentication token that will be used to authenticate the webhook request. |
Examples
Example Webhook:
