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 individual messages from external communication or 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 messages.
| Field | Type | Description |
|---|---|---|
containerId | ID | Identifier of the container (e.g., conversation, channel) that holds this message. |
createdAt | DateTime | Timestamp when the message was created. |
createdBy | User | User who created this message. |
description | String | Description or summary of the message. |
displayName | String | Display name or title of the message. |
externalId | ID | Identifier of the message in the external system. |
hidden | Boolean | Indicates whether the message is hidden from normal view. |
id | ID! | Unique identifier for the message. This ID is globally unique across the entire Teamwork Graph. |
isPinned | Boolean | Indicates whether the message is pinned in its conversation or channel. |
lastActiveAt | DateTime | Timestamp of the last activity on this message (e.g., last reply, reaction). |
lastUpdatedAt | DateTime | Timestamp of the most recent update to the message. |
lastUpdatedBy | User | User who last updated this message. |
parentId | ID | Identifier of the parent message if this is a reply in a thread. |
The following relationships are currently supported for External messages:
Relationships where External messages is the source object.
| Relationship name | From object type | To object type |
|---|---|---|
| External message has child external message | External messages | External messages |
Rate this page: