---
title: "Integrations"
description: "Connect TraceRTM with your existing development tools and workflows"
---

# Integrations

TraceRTM integrates with your existing development ecosystem, connecting issue trackers, version control systems, CI/CD pipelines, and communication tools for seamless traceability.

## Why Integrate?

### Unified Traceability

Connect artifacts across systems:

```
Jira Issue → TraceRTM Feature → GitHub PR → Jenkins Build → Test Results
```

### Real-Time Synchronization

Changes flow bidirectionally:

```python
from tracertm import TraceRTMClient

client = TraceRTMClient()

# When Jira issue updates, TraceRTM artifact updates
# When TraceRTM artifact changes, linked systems are notified
```

### Automated Workflows

Trigger actions based on events:

```yaml
# .tracertm/config.yaml
integrations:
  triggers:
    - on: status_change
      to: done
      actions:
        - notify_slack: "#releases"
        - update_jira: "status=Done"
        - tag_github_pr: "released"
```

## Available Integrations

### Issue Trackers

| Integration | Features |
|-------------|----------|
| [Jira](/docs/wiki/concepts/integrations/jira) | Sync issues, epics, sprints |
| [Azure DevOps](/docs/wiki/concepts/integrations/custom) | Work items, boards |
| [Linear](/docs/wiki/concepts/integrations/custom) | Issues, projects |
| [Asana](/docs/wiki/concepts/integrations/custom) | Tasks, projects |

### Version Control

| Integration | Features |
|-------------|----------|
| [GitHub](/docs/wiki/concepts/integrations/github) | Repos, PRs, issues |
| [GitLab](/docs/wiki/concepts/integrations/gitlab) | MRs, issues, pipelines |
| [Bitbucket](/docs/wiki/concepts/integrations/custom) | PRs, pipelines |

### CI/CD

| Integration | Features |
|-------------|----------|
| [Jenkins](/docs/wiki/concepts/integrations/jenkins) | Builds, tests |
| [GitHub Actions](/docs/wiki/concepts/integrations/github) | Workflows |
| [GitLab CI](/docs/wiki/concepts/integrations/gitlab) | Pipelines |
| [CircleCI](/docs/wiki/concepts/integrations/custom) | Pipelines |

### Communication

| Integration | Features |
|-------------|----------|
| [Slack](/docs/wiki/concepts/integrations/slack) | Notifications, commands |
| [Microsoft Teams](/docs/wiki/concepts/integrations/teams) | Notifications, cards |
| [Email](/docs/wiki/concepts/integrations/custom) | Alerts, reports |

## Quick Start

### Enable an Integration

```bash
# List available integrations
tracertm integrations list

# Enable GitHub integration
tracertm integrations enable github

# Configure credentials
tracertm integrations configure github \
  --token "ghp_xxxx" \
  --org "mycompany" \
  --repo "myproject"

# Test connection
tracertm integrations test github
```

### Python SDK

```python
from tracertm import TraceRTMClient
from tracertm.integrations import GitHubIntegration

client = TraceRTMClient()

# Configure integration
github = GitHubIntegration(
    token="ghp_xxxx",
    owner="mycompany",
    repo="myproject"
)

client.register_integration(github)

# Now GitHub PRs are automatically linked
```

## Integration Features

### Auto-Linking

Automatically link artifacts when references are found:

```yaml
integrations:
  auto_link:
    patterns:
      # Jira references in commits
      - source: github_commit
        pattern: "PROJ-\\d+"
        link_to: jira_issue
        link_type: implements

      # TraceRTM references in PRs
      - source: github_pr
        pattern: "FEAT-\\d+"
        link_to: tracertm_item
        link_type: realizes
```

### Status Synchronization

Keep statuses in sync across systems:

```yaml
integrations:
  sync:
    jira_to_tracertm:
      "To Do": draft
      "In Progress": in_progress
      "In Review": review
      "Done": done

    tracertm_to_jira:
      draft: "To Do"
      in_progress: "In Progress"
      review: "In Review"
      done: "Done"
```

### Field Mapping

Map custom fields between systems:

```yaml
integrations:
  field_mapping:
    jira:
      customfield_10001: story_points
      customfield_10002: risk_level
      priority: priority
```

### Webhooks

Receive events from external systems:

```python
# TraceRTM receives webhook from Jira
@client.webhook_handler("jira")
def handle_jira_webhook(event):
    if event.type == "issue_updated":
        # Update corresponding TraceRTM item
        client.sync_from_jira(event.issue_key)
```

## Common Workflows

### Requirements to Code

```
1. PM creates Jira issue
2. TraceRTM imports as Feature artifact
3. Developer references Feature in GitHub PR
4. TraceRTM auto-links PR to Feature
5. CI runs tests, results linked to Feature
6. Feature shows full traceability chain
```

### Test Coverage Tracking

```
1. Features in TraceRTM linked to Jira stories
2. Tests in TraceRTM linked to test files in GitHub
3. Jenkins runs tests, reports results
4. TraceRTM updates coverage metrics
5. Slack notifies team of coverage changes
```

### Release Management

```
1. Create baseline in TraceRTM
2. Generate release notes from linked changes
3. Tag GitHub release
4. Update Jira versions
5. Notify Slack channel
```

## Configuration

### Global Settings

```yaml
# .tracertm/config.yaml
integrations:
  # Enable/disable all integrations
  enabled: true

  # Sync frequency for polling integrations
  sync_interval: 300  # seconds

  # Retry settings
  retry:
    max_attempts: 3
    backoff: exponential

  # Logging
  log_level: info
```

### Credentials Storage

```yaml
# Use environment variables
integrations:
  github:
    token: ${GITHUB_TOKEN}

  jira:
    email: ${JIRA_EMAIL}
    api_token: ${JIRA_API_TOKEN}

# Or use secret manager
integrations:
  secrets:
    provider: vault  # or aws_secrets, azure_keyvault
    path: "secret/tracertm"
```

## Topics

Explore specific integrations:

- [Jira](/docs/wiki/concepts/integrations/jira) - Atlassian Jira integration
- [GitHub](/docs/wiki/concepts/integrations/github) - GitHub repos, PRs, issues
- [GitLab](/docs/wiki/concepts/integrations/gitlab) - GitLab MRs, issues, CI
- [Jenkins](/docs/wiki/concepts/integrations/jenkins) - Jenkins build integration
- [Slack](/docs/wiki/concepts/integrations/slack) - Slack notifications
- [Microsoft Teams](/docs/wiki/concepts/integrations/teams) - Teams integration
- [Custom Integrations](/docs/wiki/concepts/integrations/custom) - Build your own

## Related Topics

- [Workflows](/docs/wiki/concepts/workflows) - Automation
- [Relationships](/docs/wiki/concepts/relationships) - Linking artifacts
- [Webhooks](/docs/wiki/guides/integration-patterns/webhooks) - Event handling

