Skip to main content
Add the existing IrisAgent AI Search widget to a Confluence page. Employees get the same search bar, AI answers, source links, follow-up questions, and feedback controls used by AI Search in the IrisAgent portal. There is no additional employee sign-in. The embed uses the same shared widget key and knowledge configuration as your existing AI Search deployment.

​
Before you start

  • Have permission to edit the Confluence page and insert an iFrame macro.
  • Get the apiKey value from your IrisAgent AI Search → Deployment settings snippet. This is the same value used by the existing search widget.
  • Confirm the widget’s knowledge configuration is appropriate for the people who will use it.
  • Ask IrisAgent to deploy the Confluence embed page and allow your exact Confluence HTTPS origin. External embedding is disabled by default.
The shared widget key can be copied from the embed configuration. Confluence page restrictions do not add individual authentication to the widget’s API. This integration preserves the existing AI Search access model.
  1. Edit the target Confluence page and insert the iFrame macro.
  2. Set its URL to the following, replacing YOUR_WIDGET_KEY with your widget’s apiKey value:
  3. Start with a width of 800 and height of 700 pixels, or use the macro’s full-width layout.
  4. Publish the page and try a question, a source link, and a follow-up.
Keep the #apiKey=... fragment in the URL. URL-encode parameter values if they contain special characters. The fragment keeps the key out of the initial page request and referrer; it does not make the shared key a secret. See Atlassian’s iFrame macro instructions for the macro’s settings.

​
Optional product settings

To use the same public-product setting as your website widget, append &usePublicProduct=true:
For a specific product, append &productId=YOUR_PRODUCT_ID instead. The existing widget’s behavior applies: an explicit product ID takes precedence over the public-product setting. These options affect the AI answer configuration, just as they do in the existing widget.

​
How it works

The Confluence page loads the existing AI Search widget. Its existing APIs generate answers, retrieve matching resources, handle follow-ups, and collect feedback. There is no new employee-search backend, per-user attribution, conversation-source label, or billing policy. The widget does not automatically read its host Confluence page or receive the context of an open Zendesk ticket. Include relevant details in your question. Open source links to verify the answer; the source application’s normal access requirements still apply.

​
Troubleshooting

​
The page refuses to display the widget

Confirm that the URL ends in /agent-assist.html before the fragment, that the embed page is deployed, and that IrisAgent has allowed your exact Confluence HTTPS origin. The framing policy checks every ancestor. If your macro adds a vendor-hosted frame, IrisAgent must verify and allow that exact origin as well. Send your IrisAgent contact the Confluence site URL and macro name. Cloud, custom domains, and Data Center all require this configuration. If framing is unavailable, add a normal link to the same full URL so people can open the widget in a new tab.

​
The page asks for an apiKey

Check that the full #apiKey=... fragment was saved in the macro URL. Use the key from the AI Search deployment snippet, not an employee login token.

​
The widget loads but answers are missing

Verify that the shared key and optional product settings match your working AI Search deployment. Check that the relevant knowledge has been ingested. This page uses the same widget and APIs as the existing search experience.