Skip to main content
The Sammy Jira integration automatically captures ticket data from your Jira issues and sends it to Sammy’s AI platform for documentation generation and knowledge updates. When issues pass through your configured transition, Sammy processes the ticket information to update your knowledge base.

​
How It Works

The integration works by adding a workflow action to any Jira transition. When an issue moves through that transition, the action automatically sends the ticket data (summary, description, comments, and any custom fields) to Sammy for processing and knowledge base updates.

​
Setup Process

1

Install the App

Install the Sammy Jira app from the Atlassian Marketplace
2

Configure API Key

Add your Sammy API key in the admin settings
3

Configure Validation (Optional)

Add action to your workflow transition
4

Configure Action

Add action to your workflow transition
5

Start Using

Create issues and transition them to trigger documentation generation

​
Requirements

What You Need

Jira Setup
  • Jira project with workflow customization support
  • Admin permissions for workflow updates
  • Admin permissions to install workspace Apps
Sammy Account
  • Active Sammy account with admin access

​
Installation Guide

​
Step 1: Install the App into your Jira Workspace

Install SAMMY into Jira

Click here to install the Sammy Jira app directly to your Atlassian instance.

​
Step 2: Configure API Connection

1

Generate SAMMY API Key

Get your API key from SAMMY\API configuration in SAMMY
2

Access Admin Configuration

Navigate to Apps → Manage Apps → SAMMY ConfigurationAdmin configuration page navigationEnter the API key in the configuration field and click saveEnter SAMMY API Key
3

Test and Save

Click Test Connection to verify your API keyTest connection

​
Step 3: Configure Validation (Optional)

Ensure Data Quality

Add validation rules to require specific fields before Sammy processes tickets. This ensures complete data capture during transitions.
1

Navigate to Workflow Settings

Navigate to Settings → Work ItemsNavigate to Work ItemsNavigate to Workflows on left hand panel and select edit on chosen workflowNavigate to Workflows
2

Choose Your Transition

Select the transition that should be validated (e.g., “In Progress → Done” or “To Do → In Review”)Choose Workflow
3

Add Validation Rule

Click add rule and choose Validate details -> Validate a fieldAdd validator
4

Configure Validation Logic

Set up your specific validation requirements for each field nameConfigure validator

​
Step 4: Configure Action

1

Choose Your Transition

Select the transition that should be used as a trigger for knowledge processing
2

Add Workflow Action

Click add rule and choose Perform action -> SAMMY - Send release contextAdd Workflow Action
3

Save and Publish Workflow

Click Update Workflow to activate the workflow changesUpdate Workflow
Validation rules run before the Action rules, so any tickets that don’t meet your validation criteria won’t finish the transition and so won’t perform the action.

​
Summary

You’ve successfully set up the Sammy Jira integration! Here’s what you’ve accomplished: ✅ Installed the Sammy app in your Jira workspace
✅ Connected to Sammy with your API key
✅ Configured workflow automation to trigger on ticket transitions Now when issues move through your configured transition, Sammy will automatically:
  • Capture ticket data (summary, description, comments)
  • Process the information for knowledge updates
  • Update your organization’s knowledge base
The integration runs seamlessly in the background, helping keep your documentation current with minimal manual effort.

​
Getting Support

If you encounter issues:
  1. Check the Sammy Status Panel for error messages
  2. Verify your API key is valid in the configuration
  3. Ensure the perform action is properly positioned in your workflow
  4. Use the Send to Sammy button to manually retry failed submissions
For additional support, contact the Sammy team with your Jira instance URL and any error messages.
⌘I