Set Up Custom API Integrations in Bot Builder

You can set up a custom integration using APIsClosed APIs allow you to automate certain functionality by connecting your CXone system with other software your organization uses.. This allows you to use your own database or third-party applications with your bot.

  1. In CXone, click the app selector and select Bot Builder.

  2. Click the bot you want to work with.
  3. Click Integrations icon, which looks like a plug. in the left icon menu.
  4. On the APIs tab, in the Custom section, click New Integration.
  5. Click the title to rename the integration.
  6. Use the drop-down to select an Authentication Method. Enter the required information for each type.
  7. Under Actions, there are a few actions built-in. You can choose to use and customize one of those, or click New Action.
  8. Type a name for the action and press Enter.
  9. Click the action to configure it.
  10. Write your configuration in the Request JSON window. Slot values can be used as variables in the format {{slot_name}}. You can use the mockSlots parameter for testing purposes.
  11. Click Test Request at any time to populate the Response window.
  12. You can use the Error Message field to determine what to show a customer in response to a failed API request.
  13. You can select the Debug Mode checkbox to add a suffix response to the error message.
  14. Ensure the action toggle at the top of the action configuration page is turned on. If the toggle is off, the action will not be available to use.
  15. If you want to add the integration to a bot skill, hover over the integration in the left column, then click OptionsThree horizontal dots > Add to Skill. If the skill already exists, select it from the list. You can select more than one. If you need to create a new skill for the data, type a name for your skill in the field, then click Create Skill "...".
  16. Click Train and Stage to train your bot on the new integration. You can also do more training and testing later.
  17. Add your action to a story, rule, or fallback. The APIs section of the bot action options will show all the API integration actions you have configured and turned on.