Last updated Feb 23, 2024

This section describes a Forge preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.

Forge remote

This is an experimental page to test an approach to task-oriented content.

In this case, the task is development of an app using Forge remote capabilities that are currently in Preview.

The idea of this page is to provide developers new to Forge remote app development with a short list of resources that will help them try out Forge remote and ultimately use it in their own apps.

If this describes you, please use the Rate this page feature at the top of the page and let us know if you found the information on this page useful and if you think there's any additional information that should be added to the page.

Forge remote capabilities allow you to integrate a Forge app with REST API services hosted on other platforms.

The Preview release includes the ability to:

  • Use a remote back end as the resolver for a Custom UI or UI Kit 2 front end.
  • Call Atlassian product APIs from a remote back end.
  • Query and modify your app's Forge storage from a remote back end.
  • Have product and lifecycle events sent directly to a remote back end.

Some use cases for these capabilities:

  • Create an integration app that sends or receives data between an Atlassian product and a third party product.
  • Invoke a complex existing application, for example your own customised large language model that provides AI services to your app, that runs on a non-Atlassian platform.

Start your Forge remote learning journey

Start with the Forge remote overview page that describes what you can do with Forge remote capabilities and how they work.

Forge remote makes particular use of some manifest.yml sections and properties, runtime APIs, and data structures you might not have encountered before, if you are building your first app that uses Forge remote capabilities.

You don't have to look at these right now, but remember that they're here for future use. You might find them valuable as you look at the Forge remote sample code.

Content areaReference
Forge remote
reference
Other related reference

The following product-specific reference materials can also be useful to Forge remote developers.

See the code for a working reference app

Reference Forge application (front end code):

Reference Back end endpoints:

The Forge portion of the app demonstrates how to define:

  • A remote resolver for a Confluence macro using Custom UI and targeting a node.js remote endpoint.
  • A remote resolver for a Confluence macro using Custom UI and targeting a Spring Boot remote endpoint.
  • A remote receiver for the avi:confluence:created:comment and avi:confluence:created:page events targeting a Spring Boot endpoint.
  • A remote receiver for the avi:confluence:created:page event targeting a node.js endpoint.

The remote app code demonstrates how to:

  • Validate and retrieve key information from a Forge Invocation Token (FIT).
  • Set, get, and delete an entry from Forge Storage using GraphQL.
  • Invoke Atlassian product APIs with app and user permissions.
  • Invoke a Confluence API with app permission to place a comment on a page in response to the avi:confluence:created:page event.
  • Invoke a Confluence API with app permissions to fetch a page in response to the avi:confluence:created:comment event.

Rate this page: