Both Teamwork Graph connectors and the Teamwork Graph API are avaible through Forge's Early Access Program.
EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice. Both Teamwork Graph connectors and the Teamwork Graph API have additional limitations and considerations to take into account while these features are in EAP. See below for more information.
For both of these features, you must be registered for the EAP in order to use the features in an app.
The following limitations and considerations apply for all apps that connect to Teamwork Graph, including apps with Teamwork Graph connectors and apps that call the Teamwork Graph API:
The following limitations and considerations apply for apps that call the Teamwork Graph API:
Do not install apps in production environments: Apps calling the Teamwork Graph API require
the read:graph:jira or read:graph:confluence scope, which provides access to Teamwork Graph data across your entire organization.
While apps still respect end-user permissions, this scope may grant access to sensitive information.
For safety, only install these apps in organizations with test data. Do not install apps using this
API in organizations with production data while this feature is in EAP.
Cannot distribute apps, including via direct distribution links or the Atlassian Marketplace: Apps using the Teamwork Graph API cannot be distributed during EAP. This include distribution via direct distribution links, as well as the Atlassian Marketplace. Timelines for general availability and distribution are not yet determined and may take longer than most other Forge features. Marketplace Partners can join the EAP but should be aware of these limitations and plan accordingly.
Runs on Atlassian (RoA) recommendation: We recommend building apps that call the Teamwork Graph API as "Runs on Atlassian" Forge apps. For Preview and General Availability, we will implement policies and controls to ensure data accessed via the Teamwork Graph API is not egressed from the Atlassian platform. See Runs on Atlassian for details.
Only supported for Jira and Confluence apps: Currently, the Teamwork Graph API is only available for apps installed into Jira or Confluence. This will also include apps that are compatible with multiple Atlassian apps with a Jira or Confluence installation. This is a limitation of the current architecture, and we are working on making this more flexible in the future.
Organization admin permissions required for installation: Installing apps with the
read:graph:jira or read:graph:confluence scope requires organization administrator permissions due to the organization-wide
data access this scope provides.
Cannot deploy to Forge production environment: As with all EAPs, apps must remain in the Forge development environment.
API design subject to change: As with all EAPs, The Teamwork Graph API design may change before general availability. All developers should plan for potential breaking changes and be prepared to update their apps accordingly.
The following limitations and considerations apply when building Teamwork Graph connectors:
An existing Forge app, including Forge apps that still use Connect modules, can implement the
graph:connector module and start ingesting data into Teamwork Graph. However, if your existing app
has previously ingested DevOps entities into Jira Software, there are some additional considerations.
This applies to any apps that use any of the following modules:
| jiraConnect modules | Forge modules |
|---|---|
jiraDevelopmentTool | devops:developmentInfoProvider |
jiraBuildInfoProvider | devops:buildInfoProvider |
jiraDeploymentInfoProvider | devops:deploymentInfoProvider |
jiraFeatureFlagInfoProvider | devops:featureFlagInfoProvider |
jiraRemoteLinkInfoProvider | devops:remoteLinkInfoProvider |
jiraSecurityInfoProvider | devops:securityInfoProvider |
Configuring a Teamwork Graph connector requires a different admin experience. While admins may have connected your app for your existing DevOps use-cases, they will need to reconnect it through Atlassian Administration to enable the full Teamwork Graph connector experience.
DevOps data sent through Jira Software and Teamwork Graph are scoped separately. For example, if a
Deployment is sent and associated to a Jira work item via both APIs, then the Jira work item will
surface two deployments.
Functionality supported in the DevOps APIs are compatible with Teamwork Graph’s APIs. Therefore, we recommend you start sending data through Teamwork Graph instead.
Old data should not be re-ingested through Teamwork Graph as this will duplicate data in Jira Software experiences. If your app supports resyncing data, then the customer can disconnect and reconnect the app so that all new data flows through Teamwork Graph. Added
Rate this page: