HTTP custom actions: create and configure an integration
Connect your AI agent to any external API so it can look up plans, log orders, or call your systems mid-conversation.
Watch this step in the video · Custom actions: creating one
What custom actions are
Custom actions are HTTP endpoints your AI agent can call on its own during a conversation. Use them to fetch live information (plans, stock, an order's status) or to write data into your systems (open a ticket, create a lead) with no human in the loop. While Native tools cover Omnifox's built-in actions (close conversation, assign, trigger a workflow), custom actions connect your agent to any external API.
Requirements
- Your organization needs the Impulsa plan or higher (the Lite plan doesn't include them). If your plan doesn't include them, you'll see a lock and a See plans button.
- The agent must be a text agent (actions are configured on text agents, not voice).
- The target API must respond over HTTPS and usually accept an authentication header (token or API key).
Steps to create an action
- Go to Settings → AI Agents and enter the agent you want to edit.
- Select the Custom actions tab.
- In the Custom actions section (below Native tools), click New action.
- Fill in the action's identity:
- Technical name: in
snake_case, e.g.check_plans. The model invokes it in the prompt as!check_plans. - Label: the human-readable name shown in the list, e.g. Check plans.
- Description (for the LLM): explain when to use it. This is the text the model reads to decide whether to call it, so be specific (10 to 500 characters).
- Technical name: in
- Configure the HTTP request:
- HTTP method: GET, POST, PUT, PATCH, or DELETE.
- URL: the full endpoint, e.g.
https://api.yourdomain.com/plans. - Headers: add whatever you need, typically
Authorization: Bearer .... - Timeout (s): between 1 and 60 seconds.
- Click Save action.
Once saved, the action shows up in the list with its method, URL, and a switch to enable or disable it.
Verification
- The new action appears in the list with the
!nametag in amber. - The switch reads Enabled.
- After saving, the Test button becomes available, which runs a real call and shows you the response. See how in Test and edit custom actions.
If it doesn't work
- I don't see the tab or there's a lock: your plan doesn't include custom actions. Click See plans and upgrade to Impulsa or higher.
- It won't save: the Technical name must be
snake_casestarting with a letter; the Description needs at least 10 characters; the URL must start withhttps://. - The agent never uses it: make sure the switch is Enabled and sharpen the Description so it's clear when to call it.
Tip: use a technical name that describes the intent (
check_stock,create_order). The model relies on the name and description to decide.
Tip: start with a simple read-only GET action. It's easier to test and won't change data if something goes wrong.
Related articles
Related articles
-
Create your first AI agent
Learn what an AI agent does in Omnifox, how to give it instructions, connect it to a channel and test it in the sandbox before it talks to real customers.
-
How to write good instructions for your AI agent
Learn how to write clear instructions so your AI agent replies with the right tone, limits and actions.
-
AI Agents complete guide
AI Agents in depth, in 65 chapters: creating, instructions, tools, knowledge, behavior, tester, inbox, workflows, analytics and usage, with every setting explained.
-
Connect your AI agent to WhatsApp, Instagram, Messenger and web chat
An agent with no channels serves nobody. Connect it to your WhatsApp, Instagram, Messenger or website chat from the Connections section, then switch it on so it starts replying.
-
Start here: AI Agents in 8 minutes
AI Agents essentials in a short video: creating an agent, its instructions, tools, knowledge, channels, the tester, hours and handing over to a person.