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 code commit from Bitbucket or an external version control 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 commit.
| Field | Type | Description |
|---|---|---|
author | User | User who authored the commit. |
commitId | ID | Identifier of the commit in the external system. |
containerId | ID | Identifier of the container (e.g., repository) that holds this commit. |
createdAt | DateTime | Timestamp when the commit was created. |
createdBy | User | User who created this commit. |
description | String | Description or summary of the commit. |
displayId | ID | Short identifier for display purposes (e.g., abbreviated hash). |
displayName | String | Display name of the commit. |
hash | String | Full hash of the commit. |
id | ID! | Unique identifier for the commit. This ID is globally unique across the entire Teamwork Graph. |
lastUpdatedBy | User | User who last updated this commit. |
message | String | Commit message describing the changes. |
provider | ExternalProvider | Provider or integration that supplies this commit. |
repositoryId | ID | Identifier of the repository containing this commit. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
url | URL | Direct URL to view the commit 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 commit:
Relationships where External commit is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| External repository has external commit | External commit | External repository |
| External pull request has external commit | External commit | External pull request |
Rate this page: