Secoda Docs
Get Started
  • Getting Started with Secoda
    • Secoda as an Admin
      • Deployment options
      • Sign in options
      • Settings
      • Connect your data
        • Define Service Accounts
        • Choose which schemas to extract
      • Customize the workspace
      • Populate Questions with FAQs
      • Invite your teammates
        • Joining & Navigating between Multiple Workspaces
      • Onboard new users
        • Onboarding email templates
        • Onboarding Homepage template
        • Training session guide
      • User engagement and adoption
        • Tips & Tricks to share with new users
    • Secoda as an Editor
    • Secoda as a Viewer
      • Introduction guide
      • Requesting changes in Secoda
  • Best practices
    • Setting up your workspace
    • Integrating Secoda into existing workflows
    • Documentation best practices
    • Glossary best practices
    • Data governance
    • Data quality
    • Clean up your data
    • Tool migrations using Secoda
    • Slack <> Questions workflow
    • Defining resources workflow
    • Streamline data access: Private and public teams workflow
    • Exposing Secoda to external clients
  • Resource Management
    • Editing Properties
      • AI Description Editor
      • Bulk Editing
      • Propagation
      • Templates
    • Resource Sidesheet
    • Assigning Owners
    • Custom Properties
    • Tags
      • Custom Tags
      • PII Identifier
      • Verified Identifier
    • Import and Export Resources
    • Related Resources
  • User Management
    • Roles
    • Teams
    • Groups
  • Integrations
    • Integration Settings
    • Data Warehouses
      • BigQuery
        • BigQuery Metadata Extracted
      • Databricks
        • Databricks Metadata Extracted
      • Redshift
        • Redshift Metadata Extracted
      • Snowflake
        • Snowflake Metadata Extracted
        • Snowflake Costs
        • Snowflake Native App
      • Apache Hive
        • Apache Hive Metadata Extracted
      • Azure Synapse
        • Azure Synapse Metadata Extracted
      • MotherDuck
        • MotherDuck Metadata Extracted
      • ClickHouse
        • ClickHouse Metadata Extracted
    • Databases
      • Druid
        • Druid Metadata Extracted
      • MySQL
        • MySQL Metadata Extracted
      • Microsoft SQL Server
        • Page
        • Microsoft SQL Server Metadata Extracted
      • Oracle
        • Oracle Metadata Extracted
      • Salesforce
        • Salesforce Metadata Extracted
      • Postgres
        • Postgres Metadata Extracted
      • MongoDB
        • MongoDB Metadata Extracted
      • Azure Cosmos DB
        • Azure Cosmos DB Metadata Extracted
      • SingleStore
        • SingleStore Metadata Extracted
      • DynamoDB
        • DynamoDB Metadata Extracted
    • Data Visualization Tools
      • Amplitude
        • Amplitude Metadata Extracted
      • Looker
        • Looker Metadata Extracted
      • Looker Studio
        • Looker Studio Metadata Extracted
      • Metabase
        • Metabase Metadata Extracted
      • Mixpanel
        • Mixpanel Metadata Extracted
      • Mode
        • Mode Metadata Extracted
      • Power BI
        • Power BI Metadata Extracted
      • QuickSight
        • QuickSight Metadata Extracted
      • Retool
        • Retool Metadata Extracted
      • Redash
        • Redash Metadata Extracted
      • Sigma
        • Sigma Metadata Extracted
      • Tableau
        • Tableau Metadata Extracted
      • ThoughtSpot
        • ThoughtSpot Metadata Extracted
      • Cluvio
        • Cluvio Metadata Extracted
      • Hashboard
        • Hashboard Metadata Extracted
      • Lightdash
        • Lightdash Metadata Extracted
      • Preset
        • Preset Metadata Extracted
      • Superset
        • Superset Metadata Extracted
      • SQL Server Reporting Services
        • SQL Server Reporting Services Metadata Extracted
      • Hex
        • Hex Metadata Extracted
      • Omni
        • Omni Metadata Extracted
    • Data Pipeline Tools
      • Census
        • Census Metadata Extracted
      • Stitch
        • Stitch Metadata Extracted
      • Airflow
        • Airflow Metadata Extracted
      • Dagster
        • Dagster Metadata Extracted
      • Fivetran
        • Fivetran Metadata Extracted
      • Glue
        • Glue Metadata Extracted
      • Hightouch
        • Hightouch Metadata Extracted
      • Apache Kafka
        • Apache Kafka Metadata Extracted
      • Confluent Cloud
        • Confluent Cloud Metadata Extracted
      • Polytomic
        • Polytomic Metadata Extracted
      • Matillion
        • Matillion Metadata Extracted
      • Airbyte
        • Airbyte Extracted Metadata
      • Informatica
        • Informatica Metadata Extracted
      • Azure Data Factory
        • Azure Data Factory Metadata Extracted
    • Data Transformation Tools
      • dbt
        • dbt Cloud
          • dbt Cloud Metadata Extracted
        • dbt Core
          • dbt Core Metadata Extracted
      • Coalesce
        • Coalesce Metadata Extracted
    • Data Quality Tools
      • Cyera
      • Dataplex
        • Dataplex Metadata Extracted
      • Great Expectations
        • Great Expectations Metadata Extracted
      • Monte Carlo
        • Monte Carlo Metadata Extracted
      • Soda
        • Soda Metadata Extracted
    • Data Lakes
      • Google Cloud Storage
        • GCS Metadata Extracted
      • AWS S3
        • S3 Metadata Extracted
    • Query Engines
      • Trino
        • Trino Metadata Extracted
    • Custom Integrations
      • File Upload
        • CSV File Format
        • JSONL File Format
        • Maintain your Resources
      • Marketplace
        • Secoda SDK
        • Upload and Connect your Marketplace Integration
        • Publish the Integration
        • Example Integrations
      • Secoda Fields Explained
    • Security
      • Connecting via Reverse SSH Tunnel
      • Connecting via SSH Tunnel
      • Connecting via VPC Peering
      • Connecting via AWS Cross Account Role
      • Connecting via AWS PrivateLink
        • Snowflake via AWS PrivateLink
        • AWS Service via AWS PrivateLink
      • Recommendations to Improve SSH Tunnel Concurrency on SSH Bastion
    • Push Metadata to Source
  • Extensions
    • Chrome
    • Confluence
      • Confluence Metadata Extracted
      • Confluence best practices
    • Git
    • GitHub
    • Jira
      • Jira Metadata Extracted
    • Linear
    • Microsoft Teams
    • PagerDuty
    • Slack
      • Slack user guide
  • Features
    • Access Requests
    • Activity Log
    • Analytics
    • Announcements
    • Audit Log
    • Automations
      • Automations Use Cases
    • Archive
    • Bookmarks
    • Catalog
    • Collections
    • Column Profiling
    • Data Previews
    • Data Quality Score
    • Documents
      • Comments
      • Embeddings
    • Filters
    • Glossary
    • Homepage
    • Inbox
    • Lineage
      • Manual Lineage
    • Metrics
    • Monitors
      • Monitoring Use Cases
    • Notifications
    • Policies
    • Popularity
    • Publishing
    • Queries
      • Query Blocks
        • Chart Blocks
      • Extracted Queries
    • Questions
    • Search
    • Secoda AI
      • Secoda AI User Guide
      • Secoda AI Use Cases
      • Secoda AI Security FAQs
      • Secoda MCP Server
    • Sharing
    • Views
  • Enterprise
    • SAML
      • Okta SAML
      • OneLogin SAML
      • Microsoft Azure AD SAML
      • Google SAML
      • SCIM
      • SAML Attributes
    • Self-Hosted
      • Additional Resources
        • Additional Environment Variables
          • PowerBI OAuth Application (on-premise)
          • Google OAuth Application (on-premise)
          • Github Application (on-premise)
          • OpenAI API Key Creation (on-premise)
          • AWS Bucket with Access Keys (on-premise)
        • TLS/SSL (Docker compose)
        • Automatic Updates (Docker compose)
        • Backups (Docker compose)
        • Outbound Connections
      • Self-Hosted Changelog
    • SIEM
      • Google Chronicle
  • API
    • Get Started
    • Authentication
    • Example Workflows
    • API Reference
      • Getting Started
      • Helpful Information
      • Audit Logs
      • Charts
      • Collections
      • Columns
      • Custom Properties
      • Dashboards
      • Databases
      • Documents
      • Events
      • Groups
      • Integrations
      • Lineage
      • Monitors
      • Resources
      • Schemas
      • Tables
      • Tags
      • Teams
      • Users
      • Questions
      • Queries
      • Getting Started
      • Helpful Information
      • Audit Logs
      • Charts
      • Collections
      • Columns
      • Custom Properties
      • Dashboards
      • Databases
      • Documents
      • Events
      • Groups
      • Integrations
      • Lineage
      • Monitors
      • Resources
      • Schemas
      • Tables
      • Tags
      • Teams
      • Users
      • Questions
      • Queries
  • FAQ
  • Policies
    • Terms of Use
    • Secoda AI Terms
    • Master Subscription Agreement
    • Privacy Policy
    • Security Policy
    • Accessibility Statement
    • Data Processing Agreement
    • Subprocessors
    • Service Level Agreement
    • Bug Bounty Program
  • System Status
  • Changelog
Powered by GitBook
On this page
  • Getting Started with Jira
  • Create a Jira Project
  • Prepare Your Jira Credentials
  • Connect Jira to Secoda
  • Push to Jira

Was this helpful?

  1. Extensions

Jira

An overview of the Jira integration with Secoda

Last updated 5 months ago

Was this helpful?

You might consider integrating your Secoda workspace with Jira if your team receives data requests through Jira.

Getting Started with Jira

There are three steps to getting started using Jira with Secoda

  1. Create a Jira project to upload your issues, or locate an existing project

  2. Prepare your Jira credentials

  3. Connect Jira to Secoda

Create a Jira Project

Note: if you have an existing project that you would like to connect, skip this step

Navigate to and login to or sign up for Jira with the same email used for Secoda. Navigate to Jira Software and find the Projects tab. If you do not have one, create a new project with a name similar that of the Secoda team it will be connected to for easy management. This can be either a team-managed or company-managed project.

Once created or found, you should see the project with its respective boards and issues:

Prepare Your Jira Credentials

There are nine items you will need in order to integrate your Jira project into Secoda:

  1. Project URL

  2. Project name

  3. Project key

  4. Issues Filter (optional)

  5. Jira API token

  6. Account email

  7. Organization ID

  8. Organization Admin API key

  9. Webhook secret

Project URL

To find your project's URL, name, and key, remain on your project's main page.

Project Name and Key

The project name and key will also be found on this page. Click the Projects tab to see a list of your projects, and find the one that you would like to integrate with Secoda. The project name will be the full name, while the project key is the 2 or 3 letter string inside of the brackets beside your project name

In this example, the project name is Marketing, and the project key is MAR. Enter these values into Secoda's Jira integration setup.

Issues Filter (optional)

If you want to filter the issues that will be synced to Secoda, you can enter a custom JQL query. Go to the Filters tab and click on/create a new filter. Once you are satisfied with the filter, change the switch found in the top right from Basic to JQL. The JQL query will pop up in the header bar, and you can copy that in the setup.

Note: The project in the filter must be the same as the project you entered from above, or no issues will be synced.

API Token

Note: Multiple API tokens can link to the same Jira project

Account Email

To find your account email, you can click on the icon in the top right corner of any Jira page, and enter it into the Account Email section of Secoda's Jira integration setup.

Note: For Jira users to appear as assignees on Secoda, you can either get an organization admin key as seen below, or have users change email visibility to "Anyone" by going through Manage Account -> Profile and Visibility -> Contact

Organization ID

Organization Admin API key

After you have logged into your organization on https://admin.atlassian.com/, head to the settings tab in the navbar. From here, click API keys on the left sidebar, and create a key with a label of your choosing. On creation, it will show you your organization ID as well as the API key.

Webhook secret

A Jira webhook is needed to use Secoda's bi-directional sync between issues and questions. To register a new webhook, go to your project's main page, open the settings menu in the top right, and click on System under Jira settings.

Note: A Jira admin is needed to do this step.

On this page, scroll down all the way on the left sidebar until you see the WebHooks option.

From there, click on the Create a WebHook button near the top right, which will open the webhook creation page.

Now, to ensure the webhook works correctly, fill in the following fields:

  • Under URL, enter the Jira webhook endpoint. If you are an on-prem customer, it will be https://your-domain.com/api/vi/integration/jira/jira-webhook/. If you are a cloud customer, it will be https://api.secoda.co/integration/jira/jira-webhook/.

  • Under Secret, either generate a secret token or create one yourself. Enter this secret into the Webhook secret field back on the Secoda integration creation page.

  • Under Events, paste the following JQL filter into the text box: issue.property[RestApiCall] != "True".

  • Enable the "updated" event under Issue, as well as the "created", "updated", and "deleted" events under Comment.

  • Scroll to the bottom and click Create to finish registering the webhook.

Your finished webhook should look something like this:

Secoda will now automatically sync a question's title, description, assignee, priority, and status with its linked Jira issue, as well as any comments that are created, updated, or deleted.

Connect Jira to Secoda

  1. Open your Secoda integrations page

  2. Click on "Connect Integration" in the top right

  3. Select Jira from the list of integrations

  4. Input your Jira credentials from Prepare Your Jira Credentials above. This includes the project URL, name, key, issues filter, API token, your Jira email, organization ID, organization admin API key, and webhook secret

  5. Select the Teams that you wish to receive the Jira issues (appearing as Questions in Secoda)

  6. Click on "Test Connection" to save the integration

  7. Once integration is created, click on “Run Sync” from Connection tab to run your first extraction

Once the Jira extraction finishes running, you will be able to view all issues from your Jira project in the desired team's Question page.

Push to Jira

Secoda Questions can be pushed to Jira as an Issue which will sync the properties found in this page Jira Metadata Extracted. To push a Question to Jira go to the Questions page and click the "Create Issue" button on the right hand side bar.

Select name, description, type, and priority then create the issue. After the issue is creating all of the properties will be synced bi-directionally between Secoda and Jira.

Note the website URL. You will take the section of URL resembling https://your-domain.atlassian.net/ and enter it into the Project URL section of Secoda's Jira integration setup. In the example screenshot above, this URL would be .

Next, you must obtain an API token for Jira. Login to and click "Create API token". When prompted, name the token the same name as your project, copy and save it somewhere secure, as it cannot be accessed afterwards. Enter this token into the respective section on Secoda's Jira integration setup.

To find your organization ID, go to , and select the workspace that you want to import. Then, the page will redirect you to https://admin.atlassian.com/o/{your-org-id}/overview and you can copy the ID from the link.

https://secoda-elai.atlassian.net/
this page
this link
Jira Metadata Extracted
this url