Getting Started with Chimpanion

Installation

There are two ways to integrate Chimpanion into your application: using our script tag or installing our NPM package.

<script src="https://cdn.chimpanion.com/widget.js?client-id=YOUR_CLIENT_ID"></script>

Account Setup

Customization Options

Chimpanion offers several customization options to match your website's design and user experience requirements.

// Using the NPM package
initChimpanion({
  clientId: 'YOUR_CLIENT_ID',
  
  // Widget positioning
  position: 'bottom-right', // 'bottom-right', 'bottom-left', 'top-right', 'top-left'
  
  // Appearance
  theme: 'light', // 'light' or 'dark'
  primaryColor: '#ff6b00', // Your brand color
  buttonText: 'Need help?', // Custom button text
  
  // Behavior
  autoOpen: false, // Automatically open the widget on page load
  showOnPaths: ['/dashboard', '/settings'], // Only show on specific paths
  hideOnPaths: ['/login', '/signup'], // Hide on specific paths
  
  // Advanced
  zIndex: 9999, // Custom z-index for the widget
  disableTelemetry: false, // Disable anonymous usage statistics
});

If you're using the script tag, you can pass these options as data attributes:

<script 
  src="https://cdn.chimpanion.com/widget.js?client-id=YOUR_CLIENT_ID" 
  data-position="bottom-right"
  data-theme="light"
  data-primary-color="#ff6b00"
  data-button-text="Need help?"
></script>

User Management

Inviting Team Members

You can invite team members to collaborate on creating and managing tours:

1. Navigate to "Settings" → "Team Members" in your Chimpanion dashboard
2. Click "Invite Team Member"
3. Enter the email address of the person you want to invite
4. Select their role (Admin, Editor, or Viewer)
5. Click "Send Invitation"

User Roles and Permissions

Creating and Managing Tours

Tours are step-by-step guides that help users navigate your application. Here's how to create and manage them:

Creating a New Tour

1. In your Chimpanion dashboard, navigate to "Tours" and click "Create New Tour"
2. Give your tour a name and description
3. Select the target URL where the tour will be displayed
4. Click "Create Tour" to enter the tour editor
5. Use the visual editor to add steps to your tour by clicking on elements in your application
6. For each step, add a title, description, and customize the appearance
7. Save your tour when finished

Editing and Deleting Tours

To edit an existing tour, navigate to "Tours" in your dashboard, find the tour you want to edit, and click the "Edit" button. Make your changes and save.

To delete a tour, click the "Delete" button next to the tour in the tours list. Confirm the deletion when prompted.

Publishing and Unpublishing Tours

Tours can be in either "Draft" or "Published" state. Only published tours are visible to your users. To publish a tour, click the "Publish" button in the tour editor or on the tours list. To unpublish a tour, click "Unpublish".

NLP Chatbot Integration

Chimpanion includes a powerful NLP (Natural Language Processing) chatbot that can understand user questions and suggest relevant tours or provide direct answers.

How It Works

When users interact with the Chimpanion widget, they can type natural language questions like "How do I create a new project?" or "Where can I find my billing information?". The NLP engine will:

1. Analyze the question to understand the user's intent
2. Search through your tours and documentation for relevant information
3. Suggest the most appropriate tour(s) that answer the question
4. Provide direct answers when possible

Training the Chatbot

The chatbot learns from your tours and documentation automatically, but you can improve its accuracy by:

• Creating comprehensive tours with clear titles and descriptions
• Adding alternative phrasings for common questions in the "NLP Training" section
• Reviewing chatbot interactions in the "Conversations" tab and improving responses for common questions

// Customize chatbot behavior
initChimpanion({
  clientId: 'YOUR_CLIENT_ID',
  chatbot: {
    enabled: true,
    welcomeMessage: 'Hi there! How can I help you today?',
    placeholderText: 'Ask me anything...',
    suggestedQuestions: [
      'How do I create a new project?',
      'Where can I find my billing information?',
      'How do I invite team members?'
    ]
  }
});

Advanced Integration

JavaScript API

Chimpanion provides a JavaScript API for programmatic control of the widget:

// Open the widget
window.Chimpanion.open();

// Close the widget
window.Chimpanion.close();

// Toggle the widget
window.Chimpanion.toggle();

// Start a specific tour by ID
window.Chimpanion.startTour('tour-123');

// Check if a tour is currently running
const isRunning = window.Chimpanion.isTourRunning();

// Listen for events
window.Chimpanion.on('tourStart', (tourId) => {
  console.log('Tour started:', tourId);
});

window.Chimpanion.on('tourComplete', (tourId) => {
  console.log('Tour completed:', tourId);
});

window.Chimpanion.on('tourStep', (tourId, stepIndex) => {
  console.log('Tour step:', tourId, stepIndex);
});

window.Chimpanion.on('widgetOpen', () => {
  console.log('Widget opened');
});

window.Chimpanion.on('widgetClose', () => {
  console.log('Widget closed');
});

window.Chimpanion.on('chatMessage', (message) => {
  console.log('Chat message:', message);
});

User Identification

To provide personalized experiences and track user progress across sessions, you can identify users:

// Identify the current user
window.Chimpanion.identify({
  id: 'user-123', // Required: Unique user ID
  email: 'user@example.com', // Optional: User email
  name: 'John Doe', // Optional: User name
  role: 'admin', // Optional: User role
  groups: ['engineering', 'frontend'], // Optional: User groups
  traits: { // Optional: Custom user traits
    plan: 'enterprise',
    company: 'Acme Inc',
    createdAt: '2023-01-01'
  }
});

User identification helps track tour completion rates, personalize content, and segment users for targeted tours.

Troubleshooting

If you continue to experience issues, please contact our support team at support@chimpanion.com or use the live chat on our website.