Webhook / API
Webhook starts a flow the moment another system calls it: a web form, your own app, your sales system, a spreadsheet script or another flow. Once the flow is saved it has its own address; anything that can send a web request with JSON can start it, with one place or a whole list. Every field it sends goes on to the next blocks, and the caller can get the flow’s results back in the answer.
In the editor: Starts the flow when another system sends a POST request with a JSON body to this flow’s webhook URL. The URL is in these settings once the flow is saved, and it accepts calls while the flow is live.
Settings
Takes items from
Pick oneOther systems send a POST request to this flow’s webhook address. Your other flows can hand it items too.
- Outside systems, at its webhook address
- Only my other flows
What sends it (optional)
TextA note for your team about who calls this flow (a form, an app, a partner). Nothing else uses it.
Fields it sends
TextThe names of the fields the caller sends. Test runs send a sample with these fields, and they show as {{field}} in the next blocks’ settings.
Comma-separated field names. Send one place as a JSON object, or several as a list (or under "items"). Every field is passed on to the next blocks.
What comes out
Each item that leaves the block carries these fields, to use in the blocks after it as {{field}}.
What the caller sends
One JSON object is one item; a list, or a list under items, places, rows, data, records or sites, is one item each. Every field with a plain value goes on as it came (up to 40 fields and 500 items); values one level down become one field each (extra.source becomes extra_source), and lists of plain values are joined. An item without a name or title is named from merchant_name, company or a similar field, else Item 1, Item 2.
name: A field the caller sent (any name works).city: Another one: a city here.lat: Latitude: with lng, the item has a position on the map.lng: Longitude.
In the settings of the next blocks
Data, area and logic blocks after the webhook fill {{field}} from the first item: a Job postings search for {{keyword}} in {{city}}, a Map business scan of {{city}}. Email and app blocks fill it for each item.
keyword: For example, what to search for, sent by the caller.city: Where to search, sent by the caller.
How to use it
A property portal sends each new listing to the flow and shows the score on the listing page a few seconds later.
The listing comes in as the item; Map business scan counts the competitors around it, and the answer goes back to the portal in the same call.
A web form lead, found and scored
A software company’s contact form sends each new lead with a company name and city.
Before: Reps looked up every form lead by hand before calling.
With the flow: Each lead arrives in the CRM with address, phone, rating and a fit score.
Search on demand
A recruiter’s internal tool sends a job title and a city, and wants companies hiring for it, there and then.
The fields the caller sends fill {{keyword}} and {{city}} in Job postings, so one flow serves every search.
Nearest depot for each delivery
A delivery company’s dispatch system sends the day’s drop-offs as a list each morning.
A list in one call becomes one item per drop-off; Find nearest adds the depot and the distance to each.
Check a merchant before onboarding
A payments company’s onboarding app sends each new merchant’s name and address before approval.
Before: An agent searched the map for every application.
With the flow: The app gets an answer with the merchant’s map listing and a yes or no in seconds.
Restaurants near a new dark kitchen
A delivery app’s planning tool sends the location of a planned kitchen and wants the restaurants within 3 km.
Send to an API posts the list back to your own system; the webhook’s answer has the results too.
Weather at reported incidents
A city’s incident system sends each new report with its position.
Each report has lat and lng, so the weather is for that exact spot.
One flow for every client
An agency’s dashboard sends a client’s category and city to the same flow whenever an account manager asks.
One flow, many clients: each call fills its own values in.
Good to know
- The address accepts calls while the flow is live. A test run uses a sample with the fields you listed.
- The caller gets the run’s results in the answer (up to 500 items). For long runs, add ?wait=0 to the address and the answer is a link to check on the run instead.
- Up to 30 calls a minute per flow, and up to 500 items from one call; the answer says if some were left out.
- Send the same Idempotency-Key header again and the call is not run twice: the first answer comes back.
- Keep the address private: anyone who has it can start the flow. If it leaks, replace it in the block’s settings; the old one stops working at once.
- The JSON body is required: a call without one, or with something that is not JSON, is refused.
Works well with
- Map business scan: Finds businesses on online maps live: name, category, rating, address, phone, website and whether it is open.
- Job postings: Live job postings: who is hiring, for what, and where.
- Find nearest: For each place, finds the nearest of your own points from a CSV you upload, for example the nearest ambulance to each accident or the nearest branch to each new lead, and adds its name and the distance.
- xMap LLM: Tell the AI what to do in plain words.
- Send to an API: Sends the results to your own system as JSON, for example your map database or data platform.
- HubSpot: Powerful CRM that offers tools for sales, customer service, and marketing automation.
Help articles
- How a flow works: Triggers, items, fields and the order blocks run in.
- Test with your own input: Try a webhook flow with the data your system will send.
- One flow for many cities: Search several cities, or take the city from the request.
- Start a flow from your system (webhook): POST JSON to the flow's address and get the results back.
- Connect two flows: Hand what one flow finds to another: Run another flow, and a From another flow start in the other one.
- Your AI employees as an org chart: See who feeds whom, and drag one employee onto another so it hands over what it finds.
Guides and terms
- Webhook: An address a system calls to send data the moment something happens.
Try it
Build a flow with Webhook / API on the home page, no account needed, or book a call. Try it live