Confluence 3.4 has reached end of life
Check out the [latest version] of the documentation
The External Gadgets section allows you to register gadgets served from external web applications (such as JIRA 4.0+) or websites (such as iGoogle or Gmail) with your Confluence installation, so that they:
- Appear in the macro browser
- Can be added and used in Confluence pages or blog posts via a gadget macro
On this page:
Obtaining the External Gadget's URL
Before registering an external web application's gadget with Confluence, you will need to obtain that gadget's URL and copy it to your computer's clipboard.
If your web application is another Atlassian application such as Confluence 3.1+ or JIRA 4.0+, please refer to the appropriate documentation to obtain the gadget URL from your other Atlassian application:
If your external gadget comes from a non-Atlassian web application or web site, please consult the relevant documentation for that application to obtain the gadget's URL.
Registering an External Gadget for Use in Confluence
To register an external web application's gadget for use in Confluence,
-
Go to the Confluence 'Administration Console'. To do this:
- Open the 'Browse' menu and select 'Confluence Admin'. The 'Administrator Access' login screen will be displayed.
- Enter your password and click 'Confirm'. You will be temporarily logged into a secure session to access the 'Administration Console'.
- Click 'External Gadgets' under 'Configuration' in the left panel. The 'External Gadgets' page is displayed.
- In the 'Add a new Gadget' section, paste your gadget's URL into the 'Gadget Specification URL' field.
- Click the 'Add' button. Your gadget will be shown in the list of registered gadgets below and it will also become available in the macro browser.
Do I need to establish an OAuth or Trusted Application relationship too?
In addition to registering an external gadget for use in Confluence, you may also need to establish an OAuth or Trusted Application relationship between the application that serves the gadget (the service provider) and Confluence (the consumer). OAuth and Trusted Application relationships are usually only required for gadgets that access user-restricted data from the external web application. Refer to Configuring OAuth for further information.
If an external web application provides anonymous access to all or some of its data and that is the only data you need to access, then establishing an OAuth or Trusted Applications relationship may be unnecessary.
Removing Access to an External Gadget in Confluence
To remove Confluence's access to an external web application's gadget,
-
Go to the Confluence 'Administration Console'. To do this:
- Open the 'Browse' menu and select 'Confluence Admin'. The 'Administrator Access' login screen will be displayed.
- Enter your password and click 'Confirm'. You will be temporarily logged into a secure session to access the 'Administration Console'.
- Click 'External Gadgets' under 'Configuration' in the left panel. The 'External Gadgets' page is displayed.
- In the 'Added Gadgets' section, click 'Remove' next to the URL of the external gadget whose access in Confluence is to be removed. The gadget will be removed from the 'Added Gadgets' list and will also be removed from the macro browser.
Screenshot: External Gadgets page
RELATED TOPICS
The big list of Atlassian gadgets
Adding JIRA Gadgets to a Confluence Page