Provident Connector for Fireflies syncs your meeting summaries, action items, and full searchable transcripts straight into SugarAI — and routes each call to the right opportunity, account, lead, or contact. Automatically. Every time.
Installation Guide
Fireflies.ai Integration for SugarAI — Installation Guide
Package version:
This guide walks a SugarAI administrator through installing, verifying, upgrading, and uninstalling the Fireflies.ai integration module. It covers prerequisites, the Module Loader install, post-install steps (Quick Repair & Rebuild, scheduler creation), and how to confirm the install is healthy.
Audience: SugarAI system administrators and implementation engineers.
Time to install: approximately 10–15 minutes, plus time to obtain a Fireflies.ai API key.
What gets installed: an admin panel under Admin → Fireflies.ai Integration, five custom fields on the Calls and Meetings modules, a scheduled job, a custom REST endpoint, a transcript dashlet view, and several entry-point endpoints.
1. Prerequisites
1.1 SugarAI Environment
| Requirement | Supported / Required Value |
|---|---|
| SugarAI edition | Enterprise (ENT), Ultimate (ULT), Sell (SELL), or Serve (SERVE) |
| SugarAI version | Any 7.6+ release that exposes ExternalResourceClient and SugarApi v11.1+ |
| PHP | Whatever your SugarAI version requires (no extra PHP extensions are introduced) |
| Filesystem access | Write access to upload/, custom/, cache/, and ability to run Quick Repair & Rebuild |
| Cron / scheduler | A working SugarAI cron job — required for automatic sync |
The manifest restricts installation to the four flavors above. Professional (PRO) and lower editions cannot install this package, because the integration relies on features (custom REST endpoints via SugarApi, scheduler hooks, custom dashlet views) that those editions don't support.
1.2 Fireflies.ai Account
- An active Fireflies.ai workspace with API access enabled.
- An API key generated from fireflies.ai → Settings → Developer Settings. The integration calls the GraphQL endpoint at
https://api.fireflies.ai/graphql. - Permission within the Fireflies workspace to read transcripts the integration is expected to sync.
1.3 Network Access
The SugarAI application server must be able to make outbound HTTPS calls to:
https://api.fireflies.ai/graphql
If your environment uses an outbound proxy or web filter, allow this host before installing. The integration uses SugarAI's built-in ExternalResourceClient, so it inherits any proxy configured at the platform level.
1.4 Permissions to Install
You must be logged into SugarAI as a user with the System Administrator role. The Module Loader, Quick Repair & Rebuild, Schedulers module, and the Fireflies admin panel itself are all admin-only.
2. Package Contents
The installer is a single ZIP file. At a glance, it includes:
| Area | What it Adds |
|---|---|
| Admin panel | Entry point firefliesAdmin and a settings page under Admin → Administration → Fireflies.ai Integration |
| Calls / Meetings | Five custom fields: fireflies_id_c, fireflies_url_c, fireflies_transcript_c, fireflies_sentiment_c, fireflies_actions_c |
| Sentiment dropdown | Application-level dropdown fireflies_sentiment_list with values Positive / Neutral / Negative |
| Sync engine | FirefliesSyncService, FirefliesClient, and FirefliesConfig classes under custom/modules/FirefliesSync/ |
| Scheduled job | fireflies_sync_job() registered as a Sugar scheduler task |
| REST API | FirefliesTranscript/{id} endpoint (v11+) used by the transcript dashlet |
| Transcript dashlet | Sidecar view fireflies-transcript with searchable, speaker-tagged transcript display |
| Diagnostics | A diagnostics page that verifies installation health |
3. Pre-Install Checklist
- Back up your SugarAI database and
custom/directory. - Confirm the SugarAI cron job is installed and running. Without it, the scheduled sync will never fire.
- Confirm no prior version of the Fireflies integration is installed. If one is, uninstall it first via Module Loader (see Section 8).
- Have your Fireflies API key ready. You will paste it into the admin panel after the package installs.
- Plan a low-traffic window. The post-install Quick Repair & Rebuild touches metadata cache and may briefly impact users.
Backups: The installer adds five custom fields to Calls and Meetings via SugarAI's standard ModuleInstaller. Although uninstall is supported and idempotent, custom fields contain real data once the integration runs. Always back up before installing.
Saving Comment...
