Lead source API

Every lead source you create in BeRocker gets its own endpoint URL. POST a lead to that URL and it lands in the CRM, attributed to that source, and gets distributed to an agent.

1. Get your endpoint URL

Create the source

Settings → Lead Management → Lead sources → + Add new source. Give it a name; optionally a plan name and per-lead price.

Copy the URL

In the URLs column, click the copy icon next to Lead save URL.

Copying a lead source endpoint URL from the URLs column

The URL looks like:

https://app.berocker.com/api/v1/auto-logistics/client/webhooks/lead/<your-api-key>/save

The key is embedded in the URL, so authentication is built in — there is no separate token to send. The same key also accepts urgent (“hot”) leads at …/<api-key>/save/hot — identical payload and response, but the lead is flagged hot and the assigned agent gets a hot-lead notification. The CRM does not currently display that URL; build it from the Lead save URL.

Always copy the URL from the CRM rather than typing it. Every endpoint on this page lives under the same prefix as the Lead save URL — replace the trailing /save with the path shown for each one.

Treat the URL like a password. Anyone who has it can create leads in your account. If it leaks, delete the source and create a new one.

2. Request

POST /api/v1/auto-logistics/client/webhooks/lead/<api-key>/save
Content-Type: application/json

3. Payload

Required

Field	Type	Notes
`first_name`	string	Must not be empty.
`phone`	string	Normalised on arrival; any common US format is fine.
`vehicles`	array	At least one vehicle.

Customer and route

Field	Type	Notes
`last_name`	string
`email`	string
`additional_phone`	string	A second number for the customer.
`origin_city`, `origin_state`	string	Optional if you send a ZIP — BeRocker back-fills city and state from it.
`origin_postal_code`	string
`origin_address`	string	Full street address, or just a ZIP.
`destination_city`, `destination_state`	string
`destination_postal_code`	string
`destination_address`	string
`origin_country`, `destination_country`	string	Default `US`.

The shipment

Field	Type	Notes
`ship_date`	date	The requested pickup date.
`drop_off_date`	date
`transport_type`	string	`open` (default) or `enclosed`.
`comment_from_shipper`	string	Free text from the customer.
`customer_comments`	string
`secondary_id`	string	Your own reference — shown as Secondary ID in the CRM.
`booking_number`	string
`customer_id_type`	string	`passport`, `driver_license` or `national_id`.
`customer_id_number`	string

The cost of a lead is not taken from the payload — it is always the source’s Per Lead Price from the Lead sources table. Send leads with a different price through a different source.

Some BeRocker editions can also take a pickup window (a first and last day) or a pickup timeframe (“how soon”) instead of a single date. Those fields are optional, are ignored by every other edition, and are documented separately in Lead Source API with pickup windows. If you are a lead provider posting on behalf of a customer, ship_date is all you need.

Each vehicle

Field	Type	Notes
`vehicle_model_year`	integer	Also accepted as `year`.
`vehicle_make`	string	Also accepted as `make`.
`vehicle_model`	string	Also accepted as `model`.
`vehicle_type`	string	See the list below.
`vehicle_inop`	boolean	`true` if the vehicle does not run.
`vin`	string
`is_custom`	boolean	`true` for a free-text vehicle that is not in the catalogue.

Vehicle types: Car, sedan, Coupe, Convertible, SUV, Van, Pickup, pickup_2_doors, pickup_4_doors, Motorcycle, ATV, Boat, RV, Travel Trailer, Other.

A lead containing a custom vehicle skips the automatic quote and is routed to an agent for manual pricing instead — a travel trailer should not be auto-quoted like a sedan.

To offer pickers instead of free-text vehicle fields, read the year, make and model lists from the Vehicle database API — the names it returns are exactly what vehicle_make and vehicle_model expect, and each model comes with its vehicle_type.

4. Example

curl -X POST "https://app.berocker.com/api/v1/auto-logistics/client/webhooks/lead/<api-key>/save" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "John",
    "last_name": "Doe",
    "email": "user@example.com",
    "phone": "5551234567",
    "origin_city": "Los Angeles",
    "origin_state": "CA",
    "origin_postal_code": "90001",
    "destination_city": "Miami",
    "destination_state": "FL",
    "destination_postal_code": "33101",
    "ship_date": "2026-09-27",
    "transport_type": "open",
    "comment_from_shipper": "Please call after 5 PM",
    "secondary_id": "WEB-10482",
    "vehicles": [
      {
        "vehicle_model_year": 2020,
        "vehicle_make": "Toyota",
        "vehicle_model": "Camry",
        "vehicle_type": "Car",
        "vehicle_inop": false
      }
    ]
  }'

5. Response

A successful save answers 200 with the lead as created. The fields worth reading:

Field	Notes
`id`	The lead’s id in BeRocker.
`bookingLink`	The customer’s booking page for this lead.
`price`	Usually `null` at this point — pricing runs in the background. Poll `booking-status` if you need it.
`leadProvider`	The name of the lead source the URL belongs to.

A validation failure answers 422. message is the first few field messages joined together (so it can be shown as-is), and errors maps each field to its message:

{ "message": "The first name field is required.", "errors": { "first_name": "The first name field is required." } }

A key that does not exist, or whose lead source is Disabled, answers 403 with "message": "Invalid credentials".

The same submission (same contact, route, date and vehicles) posted again within 30 minutes — a provider retry, for instance — is answered with the lead already created rather than a duplicate.

6. Checking the price — `booking-status`

One read-only endpoint sits next to the save URL, under the same key. Your own quote form uses it to know when the automatic quote is ready; the walkthrough is in Build your own quote form.

GET /api/v1/auto-logistics/client/webhooks/lead/<api-key>/<lead-id>/booking-status

Whether the automatic quote for a lead you just saved is ready.

{ "id": 123, "price": 1250, "priceReady": true, "priceFailed": false, "manualReview": false, "autoPriceEnabled": true, "bookingLink": "https://…" }

Field	Meaning
`priceReady`	A usable price exists. Safe to send the customer to `bookingLink`.
`priceFailed`	No price is coming — pricing gave up, the vehicle needs manual review, or the account does not auto-quote. Show your own follow-up message.
`manualReview`	The lead has a custom vehicle and an agent will price it by hand. Stop polling.
`autoPriceEnabled`	Whether a price was ever going to be computed for this lead. `false` means the account does not auto-quote — skip the wait entirely.

The endpoint answers 404 for a lead that belongs to another organization.

7. What happens next

The lead is created

Attributed to the source whose URL you posted to.

It is assigned

Per your lead distribution rota — quotas, shift hours, and the after-hours fallback.

It may be quoted automatically

If Auto Price is on in Pricing, and no vehicle is custom.

It shows up everywhere

In Inbox as a conversation and in Shipments as a row.

Testing and troubleshooting

Send one lead with your own name and phone number and watch it arrive.

Symptom	Check
404	The URL path, including the trailing `/save`.
403 “Invalid credentials”	The key is wrong, or the lead source’s Status is Disabled.
422	`first_name`, `phone` and at least one vehicle are all required.
Lead arrives but is not assigned	Distribution quotas are 0, or you are outside shift hours with no fallback.
Vehicle type is wrong	`vehicle_type` is not one of the listed values — BeRocker matches loosely, but exact values are safest.
City and state are empty	Send `origin_postal_code` / `destination_postal_code` and they will be filled in.
Nothing arrived at all	Check Settings → Lead Management → Logs — the raw payload is recorded there.

If your provider emails leads instead of posting them, use Email parsing rather than this API.

Build your own quote form

The full flow: ask what to show, save, wait for the price, hand off to booking.

Lead sources

Create the source and get the URL.

Lead distribution

Who receives these leads.

Lead Source API with pickup windows

Optional pickup fields, for editions that have them.

Phone, SMS and WhatsApp

Email

Load boards

Payments

Accounting

Leads and AI

1. Get your endpoint URL

2. Request

3. Payload

Required

Customer and route

The shipment

Each vehicle

4. Example

5. Response

6. Checking the price — `booking-status`

7. What happens next

Testing and troubleshooting

Build your own quote form

Lead sources

Lead distribution

Lead Source API with pickup windows

​1. Get your endpoint URL

​2. Request

​3. Payload

​Required

​Customer and route

​The shipment

​Each vehicle

​4. Example

​5. Response

​6. Checking the price — booking-status

​7. What happens next

​Testing and troubleshooting

​Related

Build your own quote form

Lead sources

Lead distribution

Lead Source API with pickup windows

1. Get your endpoint URL

2. Request

3. Payload

Required

Customer and route

The shipment

Each vehicle

4. Example

5. Response

6. Checking the price — `booking-status`

7. What happens next

Testing and troubleshooting

Related