RubikChat

Actions

Custom API actions allow your application to extend its capabilities by connecting to your own backend services. This guide walks you through the essential steps to build, configure, and test these custom actions efficiently.

1. Understanding Available Actions

  • In the Actions section of your app, several predefined action templates help you perform common tasks such as data collection, table search, file upload, and order management. Examples include:
  • Action Data Collection: This action helps you collect the data of the user that is important for your business. It will be collected and highlighted in the leads section .
  • Action Check Availability: Allows users to check the availability of records based on a specific date from any given table. This can be used to check available time slots, resources, events, or any date-based data in your system.
  • File Upload: For businesses like recruiting agencies, you can add an action to allow candidates to upload their resumes.
  • Table Search: This action allows the user to search the data that is uploaded in forms of tables on the AI chatbot.

2. Adding A New Custom Action

  • Click the Add New button to start creating a custom action.
  • You will be presented with a multi-step form starting with the About tab, where you:
  • Enter a Name describing the action’s purpose
  • Provide a Description explaining when the action should be used

3. Configure API Connection

  • Next, move to the API Connection tab to define how your custom action communicates with your backend
  • Specify data inputs the agent should collect from users.
  • Define the API Request method (GET, POST, etc.) and enter the API endpoint URL.
  • Add any necessary HTTP Headers, such as authorization tokens.

4. Test The API Response

  • Validate your API setup by providing example input values for dynamic parameters and clicking Run Test.
  • Confirm the system receives expected results.
  • Troubleshoot and adjust inputs or endpoint as needed..

5. Review And Confirm

  • Finally, review your custom action details:
  • Verify action Name and Description.
  • Check the HTTP Method, Endpoint, and Headers.
  • Click Confirm & Save to add your action, then Finish the setup.
  • By following these steps, you can seamlessly integrate custom API actions that enhance your application's capabilities and deliver smooth user experiences.

6. Monitor Character Limit

  • Keep an eye on the total character count displayed.
  • Monitor the detected characters count to ensure your data stays within the allowable limit.

7. Retrain Your Chatbot

  • After entering all necessary data, don’t forget to click the “Retrain Chatbot” button.
  • This process updates the chatbot's knowledge base with the new training data.

8. Test Your Chatbot

  • Once retraining is complete, conduct tests to ensure the chatbot responds accurately to user queries.
  • Adjust and refine the training data as needed based on user interactions and feedback.

9. Retrain Your Chatbot

  • After entering all necessary data, don’t forget to click the “Retrain Chatbot” button.
  • This process updates the chatbot's knowledge base with the new training data.
  • Properly training your chatbot with comprehensive and organized data leads to enhanced performance and user satisfaction. By following these steps, you can ensure your chatbot is well-equipped to handle inquiries and provide exceptional service to your users.