API call during the conversation
With the CRM System tool, your agent calls your system during the call to enter or look up data, such as a lead or an order status.
With the CRM System tool, your agent connects to your system during the conversation. It asks for the details you define and sends them via HTTP to your URL, for example to create a lead, open a ticket or look up an order status. If your system responds with data, the agent can tell the caller.
When to use this tool and when another
| Goal | Tool |
|---|---|
| Enter or look up data during the conversation | CRM System on the Tools tab |
| Load context when the phone rings | Incoming Webhook |
| Hand over conversation data after the call | CRM Ticket under Automation, see n8n |
Creating the tool
The wizard guides you through the setup in four steps.
- Template: open Tools › Add › CRM System. Choose an industry, such as trades, real estate or insurance, or start blank.
- Dynamic Parameters: decide which details the agent asks for during the conversation. With AI Agent, you describe your case in one sentence and let it suggest the parameters.
- Configure Endpoint: enter the tool name, waiting text, description for AI and the URL. Under Advanced Settings, you set the timeout and headers.
- Copy Prompt Template: bhomy generates a section for your prompt. Copy it with Copy prompt and paste it into the prompt on the Personality tab.
Parameters
For each parameter, you define:
| Detail | Meaning |
|---|---|
| Name | field name in the JSON sent, such as first_name |
| Type | Text, Number, Email, Phone, Date, Yes/No or Select with comma-separated options |
| Required | The agent only calls the tool once all required details are available |
| Question | how the agent asks for it, such as "What is your full name?" |
| Description | what belongs in the field |
Endpoint
| Field | Meaning |
|---|---|
| Tool name | the name the agent knows the tool by, such as "Create lead" |
| Waiting text | a sentence the agent says during the call, such as "I'm entering your details now." |
| Description (for AI) | when the agent calls the tool, such as "Creates a new lead. Only call when all required fields have been collected." |
| Webhook Endpoint | method POST or GET and the URL of your system |
| Fire-and-Forget | on: only send, the response isn't evaluated. Off: the agent receives the response and can use it |
| Timeout (ms) | how long the agent waits for the response |
| Headers | such as Authorization: Bearer … or X-Api-Key |
The Request Body Preview shows what's sent. With POST, the parameters go as JSON in the body; with GET, as query parameters.
{
"first_name": "Anna",
"last_name": "Berger",
"phone": "+491701234567",
"request": "Quote for a heat pump"
}
Your system's response
With Fire-and-Forget switched off, bhomy passes your system's response on to the agent. Respond with a JSON object that can be read out:
{ "status": "shipped", "delivery_date": "Thursday", "carrier": "DHL" }
The agent turns it into an answer, such as "Your order has been shipped and will arrive on Thursday with DHL." If your system responds with an error or too late, the agent tells the caller that it didn't work just now and offers another way. It doesn't mention status codes or error messages.
Security and speed
| Point | Recommendation |
|---|---|
| Authentication | Check a secret header. There are no fixed IP addresses |
| Speed | Respond within a few seconds. The caller waits while your system works |
| Data | Only return what the agent may say. The agent can tell the caller anything in the response |
What the agent sent and received is shown in the call history under Main Logs.
Was this page helpful?