This article presents a possible use case and corresponding sample flow that you can support.
Your app integrates with a 3rd-party shipping service to track packages. You can expose that tracking capability as a tool so Aria can look up shipment status for a Wix user during a chat.
To implement:
In the Tools Provider Config extension, set your service plugin base URI. This enables Wix to locate your method implementation and invoke it.
Implement runTool so Wix can call your package-tracking method. Aria sends a request which includes a methodName and payload. The payload should contain the necessary data for your tool.
Note: Wix doesn't validate payload against your requestSchema before calling your service plugin. Handle missing or unexpected fields in your implementation. If your implementation returns an error or times out, Aria continues the conversation without the tool result.
Your handler routes on methodName, looks up the shipment, and returns the result. For example:
To track a package when a Wix user asks Aria for shipping status:
The Wix user asks Aria a question. For example, "Where's the package?".
Aria reads the active tools and selects getPackageTracking based on the tool's description.
Aria uses the request schema to ask the Wix user for a tracking number if they haven't provided one yet.
After the Wix user provides the tracking number, Wix calls Run Tool on your service with a request like this:
Your runTool handler returns a response like this:
The service plugin passes the response back to Aria, which tells the Wix user the package is in transit and shares the location and estimated delivery date in natural language.
Last updated: 9 August 2026