Custom HTTP

Build custom HTTP tools to connect your text channel agent to any external API or service.


Overview

Custom HTTP tools allow you to define API calls that your agent can execute during text conversations (SMS, WhatsApp, Instagram, Gmail). This is useful for integrating with internal systems or APIs not available in the marketplace.

Create custom API tool modal

Creating a Custom Tool

Navigate to your agent’s Tools tab, click Add Tool, and select Custom HTTP.


Configuration Fields

Basic Information

FieldDescription
Tool NameEnter a descriptive name for your custom tool
DescriptionExplain what this tool does - helps the AI understand when to use it

HTTP Configuration

FieldDescription
API URLThe endpoint URL for your API
MethodHTTP method: GET, POST, PUT, PATCH, or DELETE
HeadersAdd request headers (e.g., Authorization: Bearer {api_token})

Request Parameters

Each request parameter has:

PropertyDescription
NameThe parameter key name
ModeChoose between Dynamic (LLM determines the value) or Variable (uses a predefined variable)
DescriptionExplain what this parameter does (for Dynamic mode)
TypeData type: String, Number, Boolean, etc.
RequiredWhether the parameter is mandatory

Authentication

Store credentials securely that can be used in headers and request body:

FieldDescription
Credential NameName to reference the credential (e.g., api_token)
Secret ValueThe actual credential value (stored securely)

Parameter Modes

Dynamic Mode

When set to Dynamic, the LLM determines the value based on the conversation context. The description helps the AI understand what value to extract from the conversation.

Example: first_name with description “The customer’s first name mentioned in the conversation”

Variable Mode

When set to Variable, select from your predefined variables (e.g., {{first_name}}, {{last_name}}). The value will be pulled from the lead’s data automatically.


Example: CRM Update Tool

Tool Name: Update CRM Contact
Description: Updates contact information in the CRM system
API URL: https://api.yourcrm.com/contacts/update
Method: POST
Headers:
- Authorization: Bearer {api_token}
Request Parameters:
- first_name (Variable): {{first_name}}
- last_name (Variable): {{last_name}}
- email (Dynamic): The customer's email if mentioned
- notes (Dynamic): Summary of the conversation
Authentication:
- api_token: your-secret-api-key

Best Practices

Be specific in the description field. Clear descriptions help the AI understand when and how to use the tool.

  • Use descriptive tool names — The AI uses the name to understand the tool’s purpose
  • Provide clear descriptions — Ambiguous descriptions lead to incorrect tool usage
  • Use Variable mode when possible — Pre-filled data is more reliable than dynamic extraction
  • Test thoroughly — Verify the tool works before deploying to production
  • Handle errors gracefully — Ensure your API returns meaningful error messages

Custom HTTP tools make external API calls during conversations. Ensure your API responds quickly to maintain smooth conversation flow.