Before you start
- You need an HTTPS API that Wizn can call, and a key or token for it if it requires one.
- Custom actions are added in Connections, then turned on per agent in the agent's Actions tab.
- Decide for each action whether it only reads (for example, look up an order) or changes something (for example, cancel an order).
Steps
- Open Connections, find Custom actions under Data and tools and choose Add action. To start from an OpenAPI 3 document instead, choose Import from OpenAPI, read the document and pick the operations to turn into actions.
- Enter a Name and What it returns or does. This text is written for the AI, which uses it to decide when to run the action.
- Choose the Type: Reads or Changes something.
- Choose the Method and enter the Address. It must start with https. Put a parameter in the address like
{order_id}. - Under Sign-in to your system, choose None, Key in a header, Bearer token or Username and password, and enter the Key or token. It is stored encrypted and never shown again.
- Under Inputs, add each input. For each one choose Where the value comes from: The AI asks the customer, or a value we add ourselves such as The verified user id, The contact's email, The contact's phone or The conversation id.
- Under What the AI may see of the answer, list the fields it may use. Leave it empty to show the whole answer, cut to the size limit.
- Choose Run test, then Save.
- Open Customer Agents, your agent, then Actions, and turn the action on.
How it stays safe
- Values we add are never chosen by the AI. The user id comes from the verified chat on our server.
- An action that Changes something asks the customer to confirm first. The customer answers yes or no, and an unanswered request expires after 15 minutes. A retried confirmation never runs the action twice.
- Calls are rate limited, and each call is logged without secrets. See Latest calls on the action. Call logs are kept for 30 days.
- The test of a Changes something action really runs it, so use sample values you can accept.
If something goes wrong
- The action cannot be saved. Check the address starts with https and each
{parameter}has an input. - The agent never uses the action. Make the description clearer, and check it is turned on for the agent.
- A call fails. Check Latest calls for the error and the timeout, which cannot exceed 20 seconds.
Related: OTP and action security. Still stuck? Write to [email protected].