Integrations

Connect Agora with third-party services to streamline your accessibility workflow. Integrations are configured per website, allowing you to customize connections based on your team's needs and project requirements.

Available Integrations

Currently, Agora supports integration with Jira for issue tracking and project management.

Jira Integration

Connect individual websites to Jira for automated accessibility issue tracking and team collaboration.

Benefits:

• Automatically create Jira tickets from accessibility violations
• Track remediation progress within your existing workflow
• Integrate accessibility testing with sprint planning
• Maintain centralized issue management across development teams

Accessing Integration Settings

1. Navigate to Website: Go to any website in your dashboard
2. Open Settings: Click the "Settings" tab for that website
3. Select Jira Tab: Choose "Jira" from the website settings tabs
4. Configure Integration: Set up authentication and project settings

Jira Integration Setup

Prerequisites

Before configuring Jira integration, ensure you have:

Jira Access Requirements:

• Active Atlassian account with project access
• Permission to create issues in target project
• Ability to generate API tokens

Required Information:

• Jira instance URL
• Account email address
• API token (not account password)
• Target project key or name

Authentication Configuration

Generating API Token

1. Access Atlassian Account: Go to your Atlassian account security settings
2. Navigate to API Tokens: Find "Security" → "Create and manage API tokens"
3. Create New Token: Click "Create API token"
4. Name Token: Give it a descriptive name (e.g., "Agora Integration")
5. Copy Token: Save the generated token securely (you won't see it again)

Configuration Steps

1. Enable Integration: Toggle "Enable Jira Integration" to activate
2. Enter Instance URL: Provide your Jira instance URL
   • Format: https://your-domain.atlassian.net
   • Must be accessible from your network
3. Enter Email: Account email associated with your Atlassian account
4. Enter API Token: Paste the API token you generated
5. Save Configuration: Click "Save Changes" to store authentication

Project Configuration

After successful authentication, configure the target project for issue creation.

Project Selection

1. Fetch Projects: Click "Fetch Projects" to load available projects
2. Choose Project: Select the project where accessibility issues will be created
3. Verify Access: Ensure you have permission to create issues in selected project
4. Save Settings: Click "Save Changes" to finalize configuration

Project Requirements

Permissions Needed:

• Create Issues permission in target project
• Edit Issues permission for updating status
• View Project permission for accessing project details

Jira Issue Creation

Automatic Issue Creation

When Jira integration is enabled and configured, Agora can automatically create issues for accessibility violations.

Issue Content Includes:

• Violation description and WCAG rule reference
• Affected URL and HTML element details
• Severity level and impact assessment
• Remediation guidance and code examples
• Screenshots highlighting the accessibility issue

Best Practices

Project Organization

Dedicated Projects: Consider separate Jira projects for accessibility issues to maintain focus

Issue Types: Create specific issue types for different violation severities:

• Critical: Blocker issues for severe accessibility problems
• High: High-priority issues for major violations
• Medium: Medium-priority issues for moderate violations
• Low: Low-priority issues for minor improvements

Workflow Integration

Sprint Planning: Include accessibility issues in sprint planning sessions

Definition of Done: Add accessibility compliance to your definition of done

Review Process: Establish review procedures for accessibility issue resolution

Documentation: Maintain documentation of accessibility standards and procedures

Troubleshooting

Authentication Issues

Invalid Credentials

• Verify email address matches Atlassian account
• Regenerate API token if authentication fails
• Check for extra spaces or characters in credentials
• Ensure Jira instance URL is correct and accessible

Permission Denied

• Verify account has project access
• Check Create Issues permission in target project
• Contact Jira administrator for permission review
• Test access by manually creating an issue in Jira

Project Configuration Issues

No Projects Available

• Verify authentication is successful before fetching projects
• Check account permissions across multiple projects
• Contact Jira administrator if no projects are visible
• Try refreshing project list after permission changes

Project Selection Fails

• Ensure selected project still exists and is accessible
• Verify project permissions haven't changed
• Check if project has been archived or restricted
• Try selecting a different project to isolate the issue

Issue Creation Problems

Issues Not Created

• Verify integration is enabled and properly configured
• Check Jira project permissions and required fields
• Monitor Agora logs for detailed error messages
• Test integration with a simple accessibility scan

Duplicate Issues

• Review Agora's duplicate detection logic
• Check if issues are being created in correct project
• Verify issue titles and descriptions for uniqueness
• Consider manual cleanup of duplicate issues

Resolution Steps

1. Verify Credentials: Test authentication outside of Agora
2. Check Permissions: Manually create issues in target project
3. Review Configuration: Ensure all settings are correct
4. Test Integration: Start with simple test cases
5. Monitor Logs: Check Agora logs for detailed error information
6. Contact Support: Provide configuration details for assistance

Next Steps

• Configure Scanning Options: Optimize scan settings for integration
• Setup Report Settings: Coordinate exports with Jira workflow
• Learn About Features: Explore accessibility testing capabilities