1 2.17 Add a New Issue Integration

github-actions[bot] edited this page 2026-02-20 20:14:22 +00:00

Table of Contents

• Add a New Issue Integration
• High-level Steps
• Full Guide
• Related

Add a New Issue Integration

How to add a new issue tracker (e.g. Jira, GitHub, GitLab-style) to Super Productivity.

New integrations implement the shared IssueProvider pattern: models, API service, and a common-interfaces service that implements IssueServiceInterface. The integration is then registered in core issue model and config.

High-level Steps

1. Create a directory under src/app/features/issue/providers/ (e.g. my-provider/).
2. Add model files (config and issue types), API service, and a common-interfaces service implementing IssueServiceInterface.
3. Add constants and config form section; implement required interface methods (e.g. isEnabled, testConnection$, getById$, searchIssues$, getFreshDataForIssueTask).
4. Register the provider in issue.model.ts (IssueProviderKey, IssueIntegrationCfg, IssueIntegrationCfgs, IssueProvider), issue.const.ts (type constant, ISSUE_PROVIDER_TYPES, DEFAULT_ISSUE_PROVIDER_CFGS, ISSUE_PROVIDER_FORM_CFGS_MAP), and ensure the issue service injects and uses it.
5. Optionally add UI (issue content, header, config) in provider-specific subfolders.
6. Run the app, add the integration in settings, and test connection and issue flow.

Full Guide

Step-by-step instructions, file templates, and the exact interface methods to implement are in the repository:

docs/add-new-integration.md

Use an existing provider (e.g. GitHub or GitLab under src/app/features/issue/providers/) as a reference.

Related

• 2.07-Manage-Task-Integrations
• 4.24-Integrations
• 3.07-Issue-Integration-Comparison

1.00-Quickstarts

• 1.01-First-Steps
• 1.02-Configure-Data-Synchronization

2.00-How_To

Using Super-Productivity

• 2.01-Downloads and Install
• 2.02-Restore-Data-From-Backup
• 2.03-Add-Tasks
• 2.04-Manage-Subtasks
• 2.05-Manage-Scheduled-Tasks
• 2.06-Manage-Repeating-Tasks
• 2.07-Manage-Task-Integrations
• 2.08-Choose-Sync-Backend
• 2.09-Configure-Sync-Backend
• 2.19-Sync-Proton-Drive-via-rclone
• 2.13-Run-with-Docker

Contributing to Super-Productivity

• 2.18-Contribute-Translations
• 2.11-Run-the-Development-Server
• 2.16-Set-Up-Development-Environment
• 2.12-Package-the-App
• 2.14-Build-for-Android
• 2.15-Develop-a-Plugin
• 2.17-Add-a-New-Issue-Integration

3.00-Reference

• 3.01-API
• 3.02-Settings-and-Preferences
• 3.03-Keyboard-Shortcuts
• 3.04-Short-Syntax
• 3.05-Web-App-vs-Desktop
• 3.06-User-Data
• 3.07-Issue-Integration-Comparison
• 3.08-Sync-Integration-Comparison
• 3.09-Theming

4.00-Concepts

Data-and-Integrations

• 4.23-Managing-Your-Data
• 4.24-Integrations

Organizing

• 4.06-Project-View
• 4.07-Tag-View
• 4.08-Time-Estimates
• 4.09-Task-Attributes
• 4.10-Task-Notes
• 4.11-Subtasks

Planning

• 4.03-Planner-View
• 4.04-Schedule-View
• 4.12-Scheduled-Tasks
• 4.13-Repeating-Tasks
• 4.08-Time-Estimates

Doing

• 4.01-The-Today-View
• 4.02-Inbox-View
• 4.05-Board-View
• 4.14-How-Time-Is-Logged
• 4.15-Timers-and-Focus-Mode
• 4.16-Break-Reminders
• 4.17-Idle-Time
• 4.08-Time-Estimates

Reviewing

• 4.14-How-Time-Is-Logged
• 4.08-Time-Estimates
• 4.18-Reflection
• 4.19-Metrics
• 4.20-Task-Archiving
• 4.22-Quick-History
• 4.21-Worklog

If you have further questions, please refer to the discussions page.