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 conversation or discussion thread from an external communication platform. Conversations include chat threads, forum discussions, or communication channels from third-party messaging systems.
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 conversation.
| Field | Type | Description |
|---|---|---|
createdAt | DateTime | Timestamp when the conversation was created. |
createdBy | User | User who created this conversation. |
description | String | Description or purpose of the conversation. |
displayName | String | Display name of the conversation as shown in the source system. |
externalId | ID | Identifier of the conversation in the external system. |
id | ID! | Unique identifier for the conversation. This ID is globally unique across the entire Teamwork Graph. |
isArchived | Boolean | Indicates whether the conversation has been archived. |
lastActiveAt | DateTime | Timestamp of the last activity in the conversation. |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the conversation. |
lastUpdatedBy | User | User who last updated this conversation. |
memberCount | Int | Number of members in the conversation. |
membershipType | String | Type of membership (e.g., "PUBLIC", "PRIVATE", "DIRECT"). |
provider | ExternalProvider | Identifier of the external provider or integration that supplies this conversation. |
thirdPartyId | ID | Additional identifier used by the third-party system. |
topic | String | Topic or subject of the conversation. |
type | String | Type or classification of the conversation (e.g., "CHANNEL", "DIRECT_MESSAGE", "GROUP"). |
url | URL | Direct URL to access or view the conversation 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 conversation:
Relationships where External conversation is the source object.
Rate this page: