Skip to main content
Version: 3.2.x

Customization

Overview​

The Zendesk application is designed to be highly customizable to meet your specific business requirements. This guide outlines various ways you can tailor the Optave Assistant for your Zendesk environment.

UI Customization​

1. User Interface Customization​

Customize the appearance to match your organization's branding using Zendesk design principles.

A. Global UI Styles​

  • Modify CSS in component files to change colors, fonts, and layouts.
  • Update theme variables for consistent styling.

B. UI Components​

  • assistantUI – Primary AI interface component. Customize its layout and interactive behavior.
  • uiElements – Components for feedback, filter tags, and language selectors.
  • navigation – Navigation components such as sidebars and headers tailored for Zendesk.
  • contentDisplay – Components for insights, sources, and other content.
  • reusableComponents – Shared UI parts used across the application.

Translation & Localization​

The Optave Assistant includes support for multiple languages and regional settings:

  • Add Languages: Create new translation files in the src/translations directory
  • Customize Messaging: Modify existing translations to match your company's tone and terminology
  • Regional Settings: Configure date formats, number formats, and other regional preferences

Integration Extensions​

Connect the Optave Assistant with additional services and data sources:

  • Zendesk API: Extend integration with additional Zendesk APIs beyond the core ticket functionality in src/app/hooks/useConversationListener
  • External Services: Connect to additional services or internal systems through API integration
  • Data Sources: Add connections to knowledge bases or other information repositories

Development Workflow​

For local development and customization:

  1. Navigate to project root in your terminal
  2. Start the development server: 
    pnpm run dev
  3. The app is now running in your local environment and can be tested in Zendesk

Deployment Options​

Configure how and where the Optave Assistant appears in Zendesk:

  • App Locations: Configure where the app appears in Zendesk:
    • Ticket sidebar (default)
    • Ticket editor
    • Navigation bar
    • Modal dialogs
  • Visibility Rules: Set conditions for when the app appears based on ticket properties
  • User Permissions: Configure access levels for different user roles

After making customizations, rebuild the application and redeploy it to your Zendesk instance following the installation instructions.