The Teamwork Graph API is available through Forge's Early Access Program (EAP).
EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.
You must only install apps that call the Teamwork Graph API in test organizations. Apps calling
the Teamwork Graph API require the read:graph:jiraor 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.
Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.
You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.
Represents a build or deployment from Bitbucket or an external CI/CD system.
The Teamwork Graph API has the following fields and properties that you can use in your queries:
You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for External build.
| Field | Type | Description |
|---|---|---|
buildNumber | Int | Build number assigned by the CI/CD system. |
containerId | ID | Identifier of the container (e.g., pipeline) that holds this build. |
createdAt | DateTime | Timestamp when the build was created. |
createdBy | User | User who created or triggered this build. |
description | String | Description of the build. |
displayName | String | Display name of the build. |
duration | Int | Duration of the build execution in milliseconds. |
externalId | ID | Identifier of the build in the external system. |
id | ID! | Unique identifier for the build. This ID is globally unique across the entire Teamwork Graph. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the build. |
lastUpdatedBy | User | User who last updated this build. |
pipelineId | ID | Identifier of the pipeline containing this build. |
provider | ExternalProvider | Provider or integration that supplies this build. |
state | String | Current state of the build (e.g., "SUCCESSFUL", "FAILED", "IN_PROGRESS", "CANCELLED"). |
thirdPartyId | ID | Additional identifier used by the third-party system. |
url | URL | Direct URL to view the build in its source system. |
| Field | Type | Description |
|---|---|---|
id | ID! | Unique identifier for the external provider. |
logoUrl | URL | URL to the provider's logo image for UI display. |
name | String | Display name of the provider (e.g., "Google Drive", "Dropbox", "GitHub"). |
The following relationships are currently supported for External build:
Relationships where External build is the target object.
| Relationship name | From object type | To object type |
|---|---|---|
| Jira work item links external build | Jira work item | External build |
| External service links external build | External Service | External build |
Rate this page: