Skip to main content
APIs (Application Programming Interfaces) connect agents to external systems via HTTP. APIs define what agents can do (e.g., view, create, update) within the system. For example, a helpdesk API may let agents read tickets but not create them, depending on the endpoint’s permissions. It is up to you while creating your custom API to confirm that the API supports the functions you need for your agent. When configuring a custom API in VIVI, you can import the Open API definition (JSON or YAML) to automatically declare the endpoints defined in the API (e.g., GET /tickets, POST /users). Custom API authentication supports both OAuth and API key.

Best Practices

I