Tool Templates

Tool templates are pre-built tool configurations for common API integrations. Instead of configuring a tool from scratch, you can select a template, customize a few settings, and have a working tool in seconds.

Browsing the Template Gallery

1. Navigate to Tools from the left sidebar.
2. Click Browse Templates in the top-right corner.
3. The template gallery shows all available templates organized by category.

imageTool template gallery showing cards for Get Account Balance, Make a Payment, Check Order Status, and other templates organized by category with search and filter controls

The tool template gallery

You can filter templates by:

• Category -- Account, Transactions, Payments, Profile, Support
• Industry -- Financial, Telecom, Utilities, Healthcare, Retail
• Search -- Search by template name or description

Built-In Templates

OmniBots includes the following system templates:

Template	Category	Description
Get Account Balance	Account	Retrieve account balance, due date, and available credit
Get Recent Transactions	Transactions	Fetch transaction history with type and limit filters
Make a Payment	Payments	Process a payment with amount and method confirmation
Update Contact Information	Profile	Update email, phone, or address on an account
Schedule Agent Callback	Support	Request a callback from an agent at a preferred time
Check Order Status	Account	Look up order status by order ID or tracking number
Report an Issue	Support	Create a support ticket with category and priority

Each template includes:

• A fully configured tool definition (URL, method, headers, body, parameters)
• Configuration hints -- step-by-step instructions for connecting to your API
• Example response -- a sample API response showing the expected data shape

Applying a Template

1. In the template gallery, find the template you want and click Use Template.
2. Optionally override the Tool ID, Name, or Description.
3. Click Create Tool. The tool is created in your Custom Tools list.

The new tool is a full copy of the template. You can modify it freely without affecting the original template.

TIP

After creating a tool from a template, you still need to configure your tenant's environment variables (like BACKEND_API and API_KEY) in Settings > Tool Environment. The template uses {{env.VARIABLE}} placeholders that must resolve to real values.

Customizing Template Parameters

Templates are designed to match common API patterns, but your API may differ. After creating a tool from a template, you can:

• Change the URL to match your API endpoint structure.
• Add or remove headers to match your authentication scheme.
• Modify the request body to include additional fields your API requires.
• Update parameters to match your API's expected input (rename fields, change types, add enum values).
• Adjust response mapping to extract the specific fields your API returns.

For example, if the "Make a Payment" template uses {{env.BACKEND_API}}/payments but your API uses /v2/accounts/{{param.account_id}}/pay, update the URL accordingly. You can also add parameters the template does not include (e.g., a currency enum).

Creating Your Own Templates

You can save any custom tool as a reusable template within your tenant:

1. Navigate to Tools and open the tool you want to save as a template.
2. Click Save as Template in the tool editor toolbar.
3. Provide a template ID, name, description, and category.
4. Optionally specify industries and configuration hints to help other users.
5. Click Save. The template appears in your tenant's template gallery.

Custom templates are scoped to your tenant. Other tenants cannot see or use them.

WARNING

System templates cannot be modified or deleted. If you need a variation of a system template, create a tool from it, customize it, and then save the customized version as your own template.

Template Categories

Category	Description	Typical Use
Account	Account lookup, balance, details	Financial services, utilities, telecom
Transactions	Transaction history and search	Banking, e-commerce
Payments	Payment processing and confirmation	Any billing scenario
Profile	Contact and profile updates	CRM-connected bots
Support	Tickets, callbacks, issue reporting	Customer service bots

Best Practices

• Start with a template when one exists for your use case. It is faster than building from scratch and follows proven patterns.
• Set environment variables first. Before testing a template-based tool, configure BACKEND_API, API_KEY, and any other {{env.*}} values in Settings > Tool Environment.
• Review configuration hints. Every system template includes setup instructions. Read them before customizing.
• Test before deploying. After creating a tool from a template, use the Test Panel to verify it works with your API.