Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Jan 8, 2026

External messages

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.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

  • Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
  • Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for External messages.

FieldTypeDescription
containerIdIDIdentifier of the container (e.g., conversation, channel) that holds this message.
createdAtDateTimeTimestamp when the message was created.
createdByUserUser who created this message.
descriptionStringDescription or summary of the message.
displayNameStringDisplay name or title of the message.
externalIdIDIdentifier of the message in the external system.
hiddenBooleanIndicates whether the message is hidden from normal view.
idID!Unique identifier for the message. This ID is globally unique across the entire Teamwork Graph.
isPinnedBooleanIndicates whether the message is pinned in its conversation or channel.
lastActiveAtDateTimeTimestamp of the last activity on this message (e.g., last reply, reaction).
lastUpdatedAtDateTimeTimestamp of the most recent update to the message.
lastUpdatedByUserUser who last updated this message.
parentIdIDIdentifier of the parent message if this is a reply in a thread.

Available relationships

The following relationships are currently supported for External messages:

Relationships where External messages is the source object.

Relationship nameFrom object typeTo object type
External message has child external messageExternal messagesExternal messages

Rate this page: