Developer
News and Updates
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 Feb 27, 2026

External conversation has external message

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 unless you have an approved path to production.

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.

The ExternalConversationHasExternalMessage relationship represents the link between an External conversation and an External message within the Teamwork Graph. It allows you to:

  • Retrieve messages within a specific conversation
  • Find which conversation a message belongs to
  • Traverse and analyze conversation-message relationships

Relationship type: Canonical

From object typesTo object types
External conversation - ati:cloud:graph:conversationExternal message - ati:cloud:graph:message

Cypher

We recommend sending parameterized Cypher queries as below instead of embedding the parameters directly in the query string. This approach will help ensure better performance.

GraphQL

1
2
query ExternalConversationHasExternalMessage_CypherQuery($cypherQuery: String!, $params: CypherRequestParams) {
  cypherQuery(query: $cypherQuery, params: $params) {
    edges {
      node {
        columns {
          value {
            ... on CypherQueryResultNode {
              id
              data {
                __typename
                ... on ExternalMessage {
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Params

1
2
{
  "cypherQuery": "MATCH (conversation:ExternalConversation {ari: $id})-[:external_conversation_has_external_message]->(message:ExternalMessage) RETURN message",
  "params": {
    "id": "$id"
  }
}

Rate this page: