Actions
Custom Action
Use a custom action when your chatbot needs to call an external workflow or business endpoint.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available QwryAI pages before exploring further.
Use a custom action when your chatbot needs to call an external workflow or business endpoint.
Configuration
Setup checklist
- Endpoint URL or workflow target
- Authentication requirements
- Request payload fields
- Success and failure handling
- A safe test endpoint
General configuration
- Give the action a descriptive name.
- Explain when the chatbot should use it.
- Define the customer inputs the action needs before it runs.
- Use an HTTPS endpoint for server workflows.
- Keep request and response data JSON-formatted.
API request
| Area | What to configure |
|---|---|
| Method | Choose the HTTP method supported by your endpoint. |
| URL | Use the production or test endpoint the chatbot should call. |
| Parameters | Pass only the values needed to filter or identify the request. |
| Headers | Send authentication and content-type metadata safely. |
| Body | Send JSON payloads with the collected inputs your endpoint expects. |
Test response
- Use live response testing when the endpoint is ready.
- Use example JSON when the endpoint is still being built.
- Limit returned fields so the chatbot sees only what it needs.
- Confirm the fallback reply when the API fails or returns incomplete data.
| Area | Check before launch |
|---|---|
| Trigger | The chatbot knows when this action should and should not run. |
| Data | Only required customer fields are sent to the action or external system. |
| Success state | The customer sees a clear confirmation after the action completes. |
| Fallback | The chatbot has a safe reply when the action fails or cannot run. |
Production check
After the action works in a test conversation, review the customer-facing text, fallback behavior, and any data sent to external systems.
Validation
- Open the selected chatbot.
- Enable or connect the action.
- Configure the required fields.
- Trigger the action in Playground.
- Confirm the result in the connected tool or help desk.
- Review the customer-facing message before launch.