Skip to content

Actions

Let the agent do things: call your API, collect leads, hand over to a person, show buttons.

On this page

Knowledge lets an agent answer. Actions let it do things: look up an order, save a lead, hand a conversation to your team, show a button. The agent decides when to use an action from the description you write.

Open an agent and select the Actions tab. How many actions a workspace may have depends on its plan; the Free plan has none.

The kinds of action

ActionWhat it doesExample
Call an APILooks something up or does something in your own systemsCheck an order's status by its number
Collect leadsAsks for contact details (name, email, phone, your own fields) and saves them on the Leads page"Want a quote? Leave your email."
Collect detailsAsks for what a case needs and saves itOrder number and date for a return
Hand over to a personPuts the conversation in the Inbox for your team; the agent stops answering"I want to speak to a human."
Show a buttonOffers a link as a button"See our pricing" → your pricing page
Suggest repliesOffers quick replies the visitor can tap"Track my order" / "Returns"
Run on your pageHands something to your website's own codeOpen your cart, pre-fill a form

Add an action

  1. Select Add action and choose its type.
  2. Give it a name: what the agent calls it, in lower case with underscores, for example order_status.
  3. Write When to use it. This is the most important field: the agent decides from it alone, so be specific.
    • Weak: "Gets orders."
    • Strong: "Use when the customer asks where their order is or when it will arrive. Needs the order number."
  4. Fill in the type's own settings (below), then save.
  5. Test it in the Playground with a question that should trigger it.

Use the switch on each action to turn it on or off without deleting it.

Actions need a model that can call tools. If an agent's model cannot, its actions are not offered to it. Choose another model in Settings.

Call an API, step by step

This lets the agent fetch live data, such as an order's status, from your own server.

  1. Method and URL. For example GET https://api.yourshop.com/orders/{{order_number}}. A {{name}} in the URL is replaced by that parameter's value.
  2. Parameters. These are the values the agent must supply, each with a name, a type (text, number, yes/no), a description and whether it is required. Example: order_number, text, "The order number, like KS-1042", required.
    • Parameters not used in the URL go in the query string for GET and DELETE, and in a JSON body for the other methods.
  3. Headers, if your API needs them.
  4. Secret header, for example Authorization: Bearer …. Its value is stored encrypted and is never shown again, not even to you.
  5. Shown while it runs is what the visitor sees while waiting. Leave it blank for "Working on it…".
  1. 1Customer asks"Where is order KS-1042?"
  2. 2Agent picks order_statusfrom your description
  3. 3ikazebot calls your APIwith the order number
  4. 4Agent answersfrom what your API returned

For safety, ikazebot only calls public internet addresses and never follows a redirect after a write. Each run is recorded without its arguments.

Run on your page

A Run on your page action does not run on our servers. It sends an event to your website, and your own JavaScript decides what to do with it:

js
ikazebot('on', 'action', ({ name, args }) => {
  if (name === 'open_cart') openCart();
});

See Widget JavaScript.

Only in procedures

Turn on Only in procedures to stop the agent using an action on its own initiative. It is then used only while the agent follows a procedure that names it. Use this for sensitive actions, like issuing a refund, that must follow your checks first.

Leads

Everything Collect leads and Collect details save appears on the Leads page, newest first. You can download it as CSV, which opens safely in Excel and Google Sheets. Leads also become contacts.

Something not working as described here? See Troubleshooting.

Get started free — 50 credits a month