Topol Documentation

Appearance

Welcome to Topol Plugin ​

Topol Plugin is an embeddable, JavaScript-based email editor designed for seamless integration into web applications. It provides a fully API-driven, white-label solution that enables SaaS platforms, CRM systems, and marketing automation tools to offer a customizable, drag-and-drop email builder within their ecosystem.

Unlike traditional standalone email editors, Topol Plugin is designed to be embedded within an existing frontend stack via a lightweight JavaScript loader. It runs inside an iframe to prevent CSS and JS conflicts, ensuring that it functions independently of the host application’s styling and scripts.

With a RESTful API for authentication, data storage, and event handling, Topol Plugin allows developers to retain full control over user data, templates, and permissions while ensuring a seamless integration experience.

Integration and API-Driven Architecture ​

Topol Plugin is initialized through JavaScript and configured via JSON-based options, making it straightforward to embed into any frontend framework, whether it’s React, Vue.js, Svelte, Angular, or vanilla JavaScript/TypeScript.

Its API-first design enables deep integration with existing infrastructure, requiring developers to use API endpoints to fetch, store, and manipulate templates, enforce authentication, and manage events like saving, loading, and exporting templates.

The authentication system is based on API keys with domain restrictions, ensuring that only authorized applications can load and interact with the editor. It supports OAuth-like workflows where users are authenticated via token-based access control, preventing unauthorized use outside designated environments.

Customization and White-Labeling ​

Topol Plugin is highly configurable, allowing developers to modify its behavior and UI through the TOPOL_OPTIONS object.

Customization options include:

  • UI modifications: Remove or replace toolbars, change branding, and apply custom themes.
  • Feature toggles: Enable or disable specific content blocks (text, images, video, buttons, etc.).
  • User permissions: Restrict functionality based on roles, such as read-only or edit access.

For white-label applications, Topol Plugin can be completely rebranded to align with the host platform’s UI, ensuring a native experience for end users.

Collaboration and Workflow Enhancements ​

Topol Plugin includes refined editing features designed for multi-user environments. It provides:

  • Active member tracking to show who is currently editing a template.
  • Commenting and annotations for review-based workflows.
  • Autosave and version control to prevent data loss and enable rollback. Versioning is handled locally or via API integration, allowing businesses to maintain their own template histories within their storage system.

Performance and Security ​

Performance is optimized for fast rendering and low latency, ensuring a smooth user experience even with complex email designs. Since the plugin runs in an isolated iframe environment, it avoids DOM contamination and CSP violations in security-conscious applications.

Security is enforced through:

  • Domain-restricted API keys to prevent unauthorized usage.
  • CORS control and secure authentication headers for API interactions.
  • GDPR-compliant data handling, ensuring that templates remain within the developer’s infrastructure.

Third-Party Integrations and Extensibility ​

Topol Plugin is designed for seamless integration with third-party services. Developers can:

  • Export templates to email marketing platforms like Mailchimp, ActiveCampaign, and SendGrid.
  • Use custom storage solutions (AWS S3, Google Cloud, or private servers) for assets and templates.
  • Load and edit templates from their own storage, with no data stored on Topol servers.

With custom file manager support, Topol Plugin allows developers to override the default asset management system and integrate their own cloud storage, CDN, or DAM solution.

Use Cases and Target Applications ​

SaaS Platforms ​

SaaS providers can embed Topol Plugin to offer native email design features, eliminating the need to build an email editor from scratch. The API allows seamless integration with multi-tenant environments, enabling user-specific template management.

CRM & Sales Tools ​

CRM applications can integrate Topol Plugin to enable direct email composition within their platform, allowing sales teams to design and send messages without leaving the app.

Marketing Automation Platforms ​

With API-controlled email templates, marketing tools can use Topol Plugin to generate personalized email content dynamically, link it to campaigns, and automate distribution.

Enterprise & Agencies ​

Enterprises and agencies benefit from real-time collaboration features, advanced permissions, and scalable API-driven workflows, making Topol Plugin a reliable solution for high-volume email production.

Next Steps ​

To explore the full capabilities of Topol Plugin, continue reading this official documentation for detailed guides on implementing custom features, API integrations, and advanced configurations.

If you’re ready to start building, sign up for a 60-day free trial and experience Topol Plugin firsthand.

For a more in-depth discussion about how Topol Plugin can enhance your platform, schedule a demo call with our team to see the product in action and get answers to your specific questions.