Atlassian has announced the timeline for Connect's phased end-of-support.
From Sep 17, 2025, only Forge apps can be submitted to the Atlassian Marketplace. All new extensibility features will be delivered only on Forge.
Have an existing Connect app? Find out how to incrementally adopt Forge from Connect.
The Navigator API enables your add-on to change the page displayed using JavaScript.
Returns the context of the current page within the host application.
This method will provide a context object to the passed in callback. This context object will contain information about the page currently open in the host application.
The object will contain a target, which can be used when calling the go
method, and a context map containing in formation about the opened page.
Currently this method supports two contexts in Confluence only:
contentview
: The host application is currently viewing a page, blog post or other content.
contentedit
: the host application is currently editing a page, blog post or other content.
Name | Type | Description |
---|---|---|
callback | function | function (location) {...} |
1 2AP.navigator.getLocation(function (location) { console.log(location) // location will be: // { // "target": "contentview", // "context": { // "contentId": 1234, // "contentType": "page", // "spaceKey": "DS" // } // } });
Navigates the user from the current page to the specified page. This call navigates the host product, not the iframe content.
Requires a target location and the corresponding context. Navigating by passing a concrete url is currently unsupported.
Name | Type | Description |
---|---|---|
target | Navigator~target~Jira || Navigator~target~Confluence | The type of page to navigate to. |
context | Navigator~context | Specific information that identifies the page to navigate to. |
1 2// To navigate to the view page for a piece of content in Confluence: AP.navigator.go('contentview', {contentId: '12345'}); // To navigate to the view page for version 2 of a piece of content in Confluence: AP.navigator.go('contentview', {contentId: '12345', versionOverride: 2}); // To navigate to the edit page for a piece of content in Confluence: AP.navigator.go('contentedit', {contentId: '12345'}); // To navigate to the issue view page of an issue in Jira: AP.navigator.go('issue', { issueKey: 'TEST-1' }); // To navigate to any page in the current site: AP.navigator.go('site', { relativeUrl: '/browse/TEST-1' });
Triggers a reload of the parent page.
Throttle is applied to prevent infinite reloads
1 2AP.navigator.reload();
Defines the available navigation targets for Confluence.
Name | Type | Description |
---|---|---|
contentview |
String |
The view page for pages, blogs and custom content. Takes a |
contentedit |
String |
The edit page for pages, blogs and custom content. Takes a |
spaceview |
String |
The space view page. Takes a |
spacetools |
String |
The space tools page. Takes a |
dashboard |
String |
The dashboard of Confluence. |
userProfile |
String |
The profile page for a specific user. Takes a |
addonModule |
String |
The module page within a specific add-on. Takes an |
contentlist |
String |
The list/collector page for pages, blogs and custom content contained in a space. Takes a |
site |
String |
A specific location contained within a site. Takes a |
Defines the available navigation targets for Jira.
Name | Type | Description |
---|---|---|
dashboard |
String |
A dashboard in Jira. Takes a |
issue |
String |
An issue in Jira. Takes an |
addonModule |
String |
A module page within an add-on. Takes an |
userProfile |
String |
The profile page for a Jira User. Takes a |
projectAdminSummary |
String |
The admin details of a Jira project. Takes a |
projectAdminTabPanel |
String |
The admin panel defined by a connect addon. Takes an |
site |
String |
A location in the site. Takes either a |
Defines the context information required for navigation targets.
Name | Type | Description |
---|---|---|
contentId |
String |
Identifies a piece of content. Required for the |
contentType |
String |
Identifies the type of content. Can be either |
spaceKey |
String |
Identifies a space. Required for the |
username |
String |
Identifies a user. One of this or |
userAccountId |
String |
Identifies a user. One of this or |
addonKey |
String |
Identifies a connect add-on. Required for the |
moduleKey |
String |
Identifies a connect add-on module. Required for the |
dashboardId |
String |
Identifies a Jira dashboard. Required for the |
projectKey |
String |
Identifies a Jira project. Required for the |
issueKey |
String |
Identifies a Jira issue. Required for the |
adminPageKey |
String |
Identifies a Jira Project Admin Tab Panels module key. Required for the |
projectId |
String |
Identifies a Jira Project by its ID number. Required for the |
customData |
String |
Contains parameters that will be added as query parameters to the product url with "ac." prepended. Used only in |
embeddedContentRender |
String |
Identifies the mode for rendering embedded content in Confluence, such as attachments embedded in a page. This only applies to the |
relativeUrl |
String |
Identifies a specific page within a site. Required for the |
absoluteUrl |
String |
Identifies a specific page within a site. Required for the |
Rate this page: