# Built-in Plugins Overview {#built-in-plugins-overview}


Ever Gauzy uses a plugin-based architecture to extend the platform with optional features, integrations, analytics, and media capture capabilities. Built-in plugins are NestJS dynamic modules that ship with the monorepo and are registered through the `PluginModule` system at bootstrap time.


## Architecture {#architecture}






```mermaid
graph TB
    subgraph App["Application"]
        subgraph Core["Core Module"]
            CM["Auth, Users, Tenants, Organizations, etc."]
        end
        PA["Plugin A (GitHub)"]
        PB["Plugin B (Upwork)"]
        PC["Plugin C (Sentry)"]
        PD["..."]
    end
```





Each plugin:

- Registers its own entities, services, and controllers
- Can extend existing entities with custom fields
- Runs migrations independently
- Has its own configuration via environment variables


## Plugin Types {#plugin-types}



### Backend Plugins {#backend-plugins}


Backend plugins can add:

| Capability           | Description                 |
| -------------------- | --------------------------- |
| **Entities**         | New database tables/columns |
| **Controllers**      | New API endpoints           |
| **Services**         | Business logic              |
| **Commands/Queries** | CQRS handlers               |
| **Event Handlers**   | React to platform events    |
| **Middleware**       | Request processing          |
| **Guards**           | Authorization rules         |


### UI Plugins {#ui-plugins}


UI plugins provide:

| Capability     | Description             |
| -------------- | ----------------------- |
| **Pages**      | New routes and views    |
| **Components** | Reusable UI components  |
| **Modules**    | Angular feature modules |
| **Services**   | Frontend business logic |


## Available Built-in Plugins {#available-built-in-plugins}



### Integration Plugins {#integration-plugins}


| Plugin                                           | Package                              | Description                             |
| ------------------------------------------------ | ------------------------------------ | --------------------------------------- |
| [AI](https://sourcey-gauzy.pages.dev/plugins-built-in/ai-plugin/index.md)                                | `@gauzy/plugin-integration-ai`       | Gauzy AI assistant, NLP, smart matching |
| [GitHub](https://sourcey-gauzy.pages.dev/integrations/github-integration/index.md)     | `@gauzy/plugin-integration-github`   | Issue sync, PRs, repos, webhooks        |
| [Upwork](https://sourcey-gauzy.pages.dev/integrations/upwork-integration/index.md)     | `@gauzy/plugin-integration-upwork`   | Time tracking and contract sync         |
| [HubStaff](https://sourcey-gauzy.pages.dev/integrations/hubstaff-integration/index.md) | `@gauzy/plugin-integration-hubstaff` | Time tracking sync                      |
| [Jira](https://sourcey-gauzy.pages.dev/integrations/jira-integration/index.md)         | `@gauzy/plugin-integration-jira`     | Issue tracking sync                     |
| [WakaTime](https://sourcey-gauzy.pages.dev/plugins-built-in/wakatime-plugin/index.md)                    | `@gauzy/plugin-integration-wakatime` | Developer metrics                       |
| [SIM](https://sourcey-gauzy.pages.dev/plugins-built-in/sim-plugin/index.md)                              | `@gauzy/plugin-integration-sim`      | AI workflow orchestration               |


### Automation Plugins {#automation-plugins}


| Plugin                                | Package                                  | Description             |
| ------------------------------------- | ---------------------------------------- | ----------------------- |
| [Zapier](https://sourcey-gauzy.pages.dev/plugins-built-in/zapier-plugin/index.md)             | `@gauzy/plugin-integration-zapier`       | 5,000+ app automations  |
| [Make](https://sourcey-gauzy.pages.dev/plugins-built-in/make-plugin/index.md)                 | `@gauzy/plugin-integration-make`         | Visual workflow builder |
| [Activepieces](https://sourcey-gauzy.pages.dev/plugins-built-in/activepieces-plugin/index.md) | `@gauzy/plugin-integration-activepieces` | Open-source automation  |


### Feature Plugins {#feature-plugins}


| Plugin              | Package                         | Description                  |
| ------------------- | ------------------------------- | ---------------------------- |
| [Documents](https://sourcey-gauzy.pages.dev/features/documents/overview/index.md) | `@gauzy/plugin-docs` | Document hub, wiki pages, review, AI knowledge |
| **Knowledge Base**  | `@gauzy/plugin-knowledge-base`  | Help center / knowledge base |
| **Product Reviews** | `@gauzy/plugin-product-reviews` | Product review system        |
| **Job Search**      | `@gauzy/plugin-job-search`      | Job board search integration |
| **Job Proposal**    | `@gauzy/plugin-job-proposal`    | Job proposal management      |
| **Changelog**       | `@gauzy/plugin-changelog`       | Release changelog management |


### Analytics & Monitoring Plugins {#analytics--monitoring-plugins}


| Plugin                           | Package                         | Description                       |
| -------------------------------- | ------------------------------- | --------------------------------- |
| **Sentry**                       | `@gauzy/plugin-sentry`          | Error tracking & performance      |
| [Analytics](https://sourcey-gauzy.pages.dev/plugins-built-in/analytics-plugins/index.md) | `@gauzy/plugin-jitsu-analytics` | Product analytics, event tracking |


### Media & Capture Plugins {#media--capture-plugins}


| Plugin                           | Package                          | Description                      |
| -------------------------------- | -------------------------------- | -------------------------------- |
| [Media Capture](https://sourcey-gauzy.pages.dev/plugins-built-in/media-plugins/index.md) | `camshot`, `soundshot`, `videos` | Screenshot, audio, video capture |


### UI Plugins {#ui-plugins-1}


UI plugins extend the frontend with pages, navigation, tabs, and dashboard widgets. They are registered in `apps/gauzy/src/plugin-ui.config.ts` and built on the [Plugin UI System](https://sourcey-gauzy.pages.dev/frontend/plugin-ui/overview/index.md) (`@gauzy/plugin-ui`).


#### Integration UI {#integration-ui}


| Plugin | Package | Description |
| ------ | ------- | ----------- |
| [Upwork UI](https://sourcey-gauzy.pages.dev/plugins-built-in/integration-upwork-ui-plugin/index.md) | `@gauzy/plugin-integration-upwork-ui` | Upwork authorization, contracts, reports, transactions |
| **GitHub UI** | `@gauzy/plugin-integration-github-ui` | GitHub integration settings UI |


#### Jobs UI (Plugin Group) {#jobs-ui-plugin-group}


The [Jobs UI plugins](https://sourcey-gauzy.pages.dev/plugins-built-in/jobs-ui/overview/index.md) use a parent-child architecture. `JobsPlugin` is the parent; child plugins contribute tabs:

| Plugin | Package | Tab / Page | Permission |
| ------ | ------- | ---------- | ---------- |
| [JobsPlugin](https://sourcey-gauzy.pages.dev/plugins-built-in/jobs-ui/overview/index.md#jobsplugin-parent) | `@gauzy/plugin-jobs-ui` | `/pages/jobs` (parent layout) | `FEATURE_JOB` |
| [JobEmployeePlugin](https://sourcey-gauzy.pages.dev/plugins-built-in/jobs-ui/job-employee-plugin/index.md) | `@gauzy/plugin-job-employee-ui` | Employee tab | `ORG_JOB_EMPLOYEE_VIEW` |
| [JobSearchPlugin](https://sourcey-gauzy.pages.dev/plugins-built-in/jobs-ui/job-search-plugin/index.md) | `@gauzy/plugin-job-search-ui` | Browse tab | `ORG_JOB_SEARCH` |
| [JobMatchingPlugin](https://sourcey-gauzy.pages.dev/plugins-built-in/jobs-ui/job-matching-plugin/index.md) | `@gauzy/plugin-job-matching-ui` | Matching tab | `ORG_JOB_MATCHING_VIEW` |
| [JobProposalTemplatePlugin](https://sourcey-gauzy.pages.dev/plugins-built-in/jobs-ui/job-proposal-template-plugin/index.md) | `@gauzy/plugin-job-proposal-ui` | Proposal Template tab | `ORG_PROPOSAL_TEMPLATES_VIEW` |
| [JobProposalPlugin](https://sourcey-gauzy.pages.dev/plugins-built-in/jobs-ui/job-proposal-plugin/index.md) | `@gauzy/plugin-job-proposal-ui` | `/pages/sales/proposals` | `ORG_PROPOSALS_VIEW` |


#### Dashboard UI {#dashboard-ui}


| Plugin | Package | Description |
| ------ | ------- | ----------- |
| [Dashboard Time Track React UI](https://sourcey-gauzy.pages.dev/plugins-built-in/dashboard-time-track-react-ui-plugin/index.md) | `@gauzy/plugin-dashboard-time-track-react-ui` | React-based time tracking widgets (demo only) |


#### Other UI Plugins {#other-ui-plugins}


| Plugin | Package | Description |
| ------ | ------- | ----------- |
| [Documents UI](https://sourcey-gauzy.pages.dev/features/documents/overview/index.md) | `@gauzy/plugin-docs-ui` | Documents hub, tree, page editor, review queue |
| **Knowledge Base UI** | `@gauzy/plugin-knowledge-base-ui` | Knowledge base frontend |
| **Onboarding UI** | `@gauzy/plugin-onboarding-ui` | Setup/onboarding wizard UI |
| **Legal UI** | `@gauzy/plugin-legal-ui` | Privacy/Terms pages |


### UI Plugin Registration {#ui-plugin-registration}


All UI plugins are registered in a single config file — `apps/gauzy/src/plugin-ui.config.ts`:

```typescript
import { IntegrationUpworkPlugin } from '@gauzy/plugin-integration-upwork-ui';
import { JobsPlugin } from '@gauzy/plugin-jobs-ui';
import { JobProposalPlugin, JobProposalTemplatePlugin } from '@gauzy/plugin-job-proposal-ui';
import { JobEmployeePlugin } from '@gauzy/plugin-job-employee-ui';
import { JobSearchPlugin } from '@gauzy/plugin-job-search-ui';
import { JobMatchingPlugin } from '@gauzy/plugin-job-matching-ui';
import { DashboardTimeTrackReactUiPlugin } from '@gauzy/plugin-dashboard-time-track-react-ui';

export const uiPluginConfig: PluginUiConfig = {
  // ... i18n config
  plugins: [
    // Flat plugin
    IntegrationUpworkPlugin,

    // Plugin group — parent with child plugins
    JobsPlugin.init({
      plugins: [
        JobProposalPlugin,
        JobEmployeePlugin,
        JobSearchPlugin,
        JobMatchingPlugin,
        JobProposalTemplatePlugin
      ]
    }),

    // Conditional — demo environments only
    ...(environment.DEMO ? [DashboardTimeTrackReactUiPlugin] : [])
  ]
};
```

For the full Plugin UI architecture, see the [Plugin UI System](https://sourcey-gauzy.pages.dev/frontend/plugin-ui/overview/index.md) guide. To build your own UI plugin, see [Getting Started](https://sourcey-gauzy.pages.dev/frontend/plugin-ui/getting-started/index.md).


## Plugin Loading & Registration {#plugin-loading--registration}


Plugins are loaded through the `PluginModule` in the API bootstrap:

```typescript
// apps/api/src/plugin-config.ts
@Module({
  imports: [
    PluginModule.init({
      plugins: [
        IntegrationAIModule,
        IntegrationGitHubModule,
        SentryTracingModule,
        // ... more plugins
      ],
    }),
  ],
})
export class AppModule {}
```

The platform discovers and dynamically imports each plugin into the NestJS dependency injection container.


## Plugin Configuration {#plugin-configuration}



### Integration Plugin Pattern {#integration-plugin-pattern}


Integration plugins follow a common pattern:

```typescript
@Module({
  imports: [
    TypeOrmModule.forFeature([IntegrationEntity, IntegrationSetting]),
    HttpModule,
  ],
  controllers: [IntegrationController],
  providers: [
    IntegrationService,
    IntegrationCommandHandler,
    IntegrationEventHandler,
  ],
})
export class IntegrationPluginModule {
  // Register OAuth callbacks, webhook endpoints, and settings
}
```


### Environment-Based Activation {#environment-based-activation}


Most plugins are controlled by environment variables:

```bash
# Feature flags
FEATURE_APP_INTEGRATION=true
FEATURE_JOB=true
FEATURE_ORGANIZATION_HELP_CENTER=true

# Integration-specific credentials
GAUZY_AI_GRAPHQL_ENDPOINT=http://localhost:3005/graphql
GITHUB_CLIENT_ID=your-github-id
HUBSTAFF_CLIENT_ID=your-hubstaff-id
JIRA_CLIENT_ID=your-jira-id
```


## Creating a Custom Plugin {#creating-a-custom-plugin}



### Step 1: Create Plugin Module {#step-1-create-plugin-module}


```typescript
// packages/plugins/my-plugin/src/lib/my-plugin.module.ts
import { Module } from "@nestjs/common";
import { TypeOrmModule } from "@nestjs/typeorm";
import { MikroOrmModule } from "@mikro-orm/nestjs";
import { MyPluginEntity } from "./my-plugin.entity";
import { MyPluginService } from "./my-plugin.service";
import { MyPluginController } from "./my-plugin.controller";

@Module({
  imports: [
    TypeOrmModule.forFeature([MyPluginEntity]),
    MikroOrmModule.forFeature([MyPluginEntity]),
  ],
  controllers: [MyPluginController],
  providers: [MyPluginService],
  exports: [MyPluginService],
})
export class MyPluginModule {}
```


### Step 2: Define Entity {#step-2-define-entity}


```typescript
import { MultiORMEntity, MultiORMColumn } from "@gauzy/core";
import { TenantOrganizationBaseEntity } from "@gauzy/core";

@MultiORMEntity("my_plugin_data")
export class MyPluginEntity extends TenantOrganizationBaseEntity {
  @MultiORMColumn()
  name: string;

  @MultiORMColumn({ type: "jsonb", nullable: true })
  config?: Record<string, any>;
}
```


### Step 3: Create Service {#step-3-create-service}


```typescript
import { Injectable } from "@nestjs/common";
import { InjectRepository } from "@nestjs/typeorm";
import { TenantAwareCrudService } from "@gauzy/core";
import { MyPluginEntity } from "./my-plugin.entity";

@Injectable()
export class MyPluginService extends TenantAwareCrudService<MyPluginEntity> {
  constructor(
    @InjectRepository(MyPluginEntity)
    private readonly myPluginRepository,
  ) {
    super(myPluginRepository);
  }
}
```


### Step 4: Register the Plugin {#step-4-register-the-plugin}


Add the plugin module to your API configuration:

```typescript
// apps/api/src/plugin-config.ts
import { MyPluginModule } from "@gauzy/plugin-my-plugin";

export const pluginConfig = {
  plugins: [
    MyPluginModule,
    // ... other plugins
  ],
};
```

For a deeper dive into plugin development, see the [Plugin System](https://sourcey-gauzy.pages.dev/development/plugin-system/index.md) guide.


## Related Pages {#related-pages}


- [Plugin System](https://sourcey-gauzy.pages.dev/development/plugin-system/index.md) — how to build plugins
- [Architecture: Plugin System](https://sourcey-gauzy.pages.dev/development/plugin-system/index.md) — plugin architecture
- [Custom Integrations](https://sourcey-gauzy.pages.dev/integrations/custom-integrations/index.md) — API-based integrations