Skip to main content

Custom Integrations - Show All Integrations

How to create a Custom Integration​

Custom Integrations are Integrations that you can create. From this dialog you can view all the custom Integrations, create, edit, export, and delete custom Integrations.

The Custom Integrations screen is designed to simplify the process of creating and configuring intelligent Integrations tailored to your specific business needs. Here, you can view, create, edit, export, and delete your custom Integrations.

Screen Elements​

  1. Header Section:

    • Title: "Integrations"
    • Description: Provides a brief overview of the screen's purpose.

  2. Search Bar:

    • Function: Allows you to search for specific Integrations by name or description.
    • Usage: Type in the search term and press the search icon (magnifying glass).

  3. Integrations List:

    • Columns:
      • Name: Displays the name of the Integration.
      • Description: Provides a brief description of what the Integration does.
      • keyName: Is The name that LLM sees, you can refer to it in the System Prompt
      • Modified: Shows the last modified date of the Integration.
      • Status: Draft or Published, if Draft mode then the reasoning engine is not aware or this custom Integration.
      • Action: Contains options to Edit, Edit property, Export, or Delete the Integration.
    • Sorting: You can sort the Integrations list by clicking on the column headers.

  4. Create Button:

    • Location: Top-right corner of the screen.
    • Function: Opens the Integration creation dialog to create a new custom Integration.

  5. Action Menu:

    • Location: Found in the 'Action' column next to each Integration.
    • Options:
      • Edit: Allows you to edit the Integration's details.
      • Edit Propery: Modify: Name, Description, Data source, Handle response, and if option to enable custom python function
      • Export: Lets you export the Integration's configuration. So you can share this with other Agent
      • Delete: Deletes the Integration.

How to Use​

  1. Creating a New Integration:

    • Click the Add Integration button at the top right of the screen

      • Select either Create Integration or Import Integration

      Add Integration button, select either Create Integration or Import Integration

  2. Edit Properties an Integration:

    • Find the Integration you wish to edit in the Integrations list.
    • Click the three vertical dots in the 'Action' column next to the Integration.
    • Select Edit Properties from the dropdown menu.
    • Purpose is to Modify: Name, Description, Data source, Handle response, and if option to enable custom python function

  3. Editing an Integration:

    • Find the Integration you wish to edit in the Integrations list.
    • Click the three vertical dots in the 'Action' column next to the Integration.
    • Select Edit from the dropdown menu.

    Add Integration button, select either Create Integration or Import Integration

  4. Exporting an Integration:

    • Locate the Integration you wish to export.
    • Click the three vertical dots in the 'Action' column next to the Integration.
    • Select "Export" from the dropdown menu.
    • Follow the prompts to export the Integration's configuration.

  5. Deleting an Integration:

    • Find the Integration you want to delete.
    • Click the three vertical dots in the 'Action' column next to the Integration.
    • Select "Delete" from the dropdown menu.
    • Confirm the deletion in the popup dialog.

Notes​

  • Ensure that you review the Integration's details before deleting, as this action cannot be undone.
  • Use the search functionality to quickly locate Integrations, especially when dealing with a large number of Integrations.