The Teamwork Graph API is available through Forge's Preview release phase.
Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.
To review the current limitations, see Limitations and considerations.
To share feedback or report an issue, visit the Atlassian developer community.
Represents a deployment from an external CI/CD or deployment system. Deployments track the release of software changes to various environments.
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 deployment.
| Field | Type | Description |
|---|---|---|
author | User | User who triggered or initiated this deployment action. |
containerId | ID | Identifier of the container (e.g., pipeline) that holds this deployment. |
createdAt | DateTime | Timestamp when the deployment was created. |
creator | User | User who created or initiated this deployment. |
deploymentSequenceNumber | Int | Sequence number for this deployment, typically incrementing with each new deployment. |
description | String | Description of the deployment. |
displayName | String | Display name of the deployment. |
duration | Int | Duration of the deployment execution in milliseconds. |
environment | ExternalEnvironment | Environment information for where this deployment was executed. |
externalId | ID | Identifier of the deployment in the external system. |
id | ID! | Unique identifier for the deployment. This ID is globally unique across the entire Teamwork Graph. |
label | String | Label or tag associated with this deployment. |
lastEditor | User | User who last updated this deployment. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the deployment. |
owners | [User] | List of users who own this deployment. |
pipeline | ExternalPipeline | Pipeline information that contains this deployment. |
provider | ExternalProvider | Provider or integration that supplies this deployment. |
region | String | Region where the deployment was executed (e.g., "us-west-2", "eu-central-1"). |
state | ExternalDeploymentState | Current state of the deployment (e.g., "SUCCESSFUL", "FAILED", "IN_PROGRESS", "CANCELLED", "ROLLED_BACK"). |
thirdPartyId | ID | Additional identifier used by the third-party system. |
url | URL | Direct URL to view the deployment in its source system. |
| Field | Type | Description |
|---|---|---|
displayName | String | Display name of the environment. |
id | ID! | Identifier of the environment. |
type | ExternalEnvironmentType | Type or classification of the environment. |
| Value | Description |
|---|---|
DEVELOPMENT | Development environment for active development work. |
PRODUCTION | Production environment serving live users. |
STAGING | Staging environment for pre-production testing. |
TESTING | Testing environment for quality assurance. |
UNMAPPED | Environment type not mapped to standard types. |
| Field | Type | Description |
|---|---|---|
displayName | String | Display name of the pipeline. |
id | ID! | Identifier of the pipeline. |
url | URL | URL to view the pipeline 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"). |
| Value | Description |
|---|---|
CANCELLED | Deployment was cancelled before completion. |
FAILED | Deployment failed. |
IN_PROGRESS | Deployment is currently in progress. |
PENDING | Deployment is pending and has not started yet. |
ROLLED_BACK | Deployment was rolled back after being deployed. |
SUCCESSFUL | Deployment completed successfully. |
UNKNOWN | Deployment state is unknown or cannot be determined. |
The following relationships are currently supported for External deployment:
Relationships where External deployment is the source object.
Rate this page: