← Sluicewell
DocumentationPrivacyTermsSupport

Sluicewell setup guide

Sluicewell takes the leads you generate and delivers each one to the right client account, once.

1. Install

Install Sluicewell from your CRM's app marketplace for all client accounts, including future ones. It can only deliver to accounts it is installed on, and your own account needs it too (the Distribute lead action and the "Lead held" and "Lead credits low" triggers run there).

Open Sluicewell from the left menu of your main view (the one that covers all your accounts).

2. Settings

  • Your own account: where usage beyond your plan is billed and where the held and low-credit triggers fire.
  • Time zone: the default for client delivery hours and caps.
  • API key: create one if you send leads from your own systems (shown once; creating a new one stops the old).

3. Clients

For each client account you deliver to:

  • Delivery hours: days and hours in the client's time zone. Outside them the client is skipped.
  • Caps: per day, week and month (in the client's time zone). Empty means no cap.
  • Credits: turn on prepaid credits and add a balance. Each delivered lead uses one; at zero the client is paused until you add more. A "Lead credits low" trigger fires once when the balance reaches the warning level.
  • Paused: stop sending leads without changing anything else.
  • Tags, opportunity (pipeline and stage) and the note with the lead's answers and return link.
  • Price per lead: for the value column in reports. We never charge your clients.

The client's report shows delivered and returned leads by day, the return rate, the value and a CSV.

4. Campaigns

A campaign is one stream of leads (a site, an ad set, a niche). For each:

  • Clients in the campaign, each with a weight (a 2 gets twice the leads of a 1) and a territory: ZIP codes or prefixes (75201, 752*), states (TX), radius areas (lat lng miles), or the client's own service areas from our map app. An empty territory means anywhere. A client matches if any rule matches.
  • How clients share leads: weighted rotation, equal turns (round robin), or priority (the first client in the list that can take it).
  • Fallback account: gets what no client can take. It ignores territory, caps and hours but never receives a duplicate or a lead it has no credits for. Without one, those leads are held for you.
  • Outside delivery hours: wait for the first client in the territory to open (up to the wait limit), or give the lead to whoever is open now.
  • Duplicate window: the same phone or email never goes to the same client twice within this many days.
  • Return window and automatic approval of returns.
  • Required: phone, email, or either. Leads without it are rejected and logged.

5. Send leads

Inbound URL (one per campaign, in the campaign editor). POST JSON or a form:

POST https://hl.greatwork.company/leads/in/<campaign key> with a body like {"first_name": "Pat", "last_name": "Buyer", "phone": "+14695550101", "email": "pat@example.com", "address": "100 Main St", "city": "Plano", "state": "TX", "zip": "75074", "roof_age": "15 years", "external_id": "fb-123"}

Names can be name or first_name/last_name; zip, postal_code and zipcode all work; lat/lng skip address lookup. Any other field is kept as an answer and shown in the note. Send an Idempotency-Key header or external_id so a retry never makes a second lead. A plain HTML form can add a hidden _redirect field (https) to send the visitor to your thank-you page. Replace the URL any time with New inbound URL.

Workflow action in your own account: add Distribute lead after a form, survey or funnel step and pick the campaign. It routes the workflow's contact and returns status (delivered, waiting, held, rejected), client_account_name, client_account_id, lead_id and reason for later steps.

API: POST https://hl.greatwork.company/leads/api/v1/leads with Authorization: Bearer <API key> and a campaign field (name or id), same fields as above. GET .../api/v1/leads/<lead id> returns its status.

6. Workflow triggers

  • Lead delivered: in the client account (with the new contact) and in your own account (with the source contact when the lead came from your workflow). Filter by campaign or client.
  • Lead held: in your own account, with the reason.
  • Lead credits low: in your own account and in the client account, with the balance.

7. Returns

The note on each delivered contact has a private return link valid for the campaign's return window. The client picks a reason; you see it under Return requests and approve (refund the credit, optionally send the lead to the next client) or decline. You can also mark any delivered lead returned yourself.

Questions

hello@greatwork.company. We reply within one business day.