Configuring an action
Enable and configure an action end to end, with a worked order-lookup example, the other five actions' fields, and how to test one safely.
Open a chatbot and choose Actions. Each available action has a card: a toggle, and the configuration that action needs. Owners and admins only.
A worked example: order lookup
Suppose your shop exposes https://api.acme.com/orders?orderId=… behind a bearer token.
1. Store the token as a credential. Under Settings → Credentials, add a secret with a name you will reference — say acme-orders — and paste the token. It is encrypted at rest and never shown again. See Credentials.
2. Configure the action. On the chatbot's Actions tab, enable lookup_order and set its endpoint:
https://api.acme.com/orders?orderId={orderId}Reference the credential by name so the call is sent with an Authorization: Bearer … header. If your URL contains {orderId} it is substituted; otherwise the order id is appended as an orderId query parameter.
3. Tell the chatbot when to use it. Add a line to the system prompt:
When a customer asks about an order, ask for the order number and look it up
before answering.4. Test it in the playground. Ask "where is order 1234?" and watch the tool status chip. The agent should call the action and answer from the result.
Only a successful (2xx) response is given back to the model. An error response is not fed into the conversation — that keeps an upstream error page from leaking internal detail, or smuggling instructions, into the answer.
Configuring the other actions
- `capture_lead` — no endpoint. Works with your
- `escalate_to_human` — no endpoint. Puts the conversation into the
Inbox queue.
- `book_appointment` — choose a provider: Cal.com booking, a Calendly
scheduling link, or your own scheduling webhook. Ask for name, email, and a date and time; a booking without them is rejected. With Cal.com or Calendly, the agent can also read real availability before proposing a slot.
- `create_ticket` — a webhook URL. The agent posts subject, body, email, and
priority along with the conversation id.
- `http_action` — a base URL, plus the hosts the call may reach.
GETorPOST, with an optional path under the configured base. The path cannot escape that host.
Every one of the last three is confirmed by the visitor before it runs — see Actions overview.
Testing safely
- 1Point the action at a staging endpoint first.
- 2Watch the action-run records to confirm what was actually sent.
- 3Only then switch the URL to production.
An enabled write action is live for real visitors on every channel that chatbot serves. Enable it when the endpoint on the other end is ready to receive real requests, not while you are still building it.
Where to go next
Last updated