Skip to main content
Add the IrisAgent AI Search widget to a Confluence page. Employees get the same search bar, AI answers, source links, follow-ups, and feedback as AI Search on your website. It uses the same shared widget key and knowledge configuration. There is no employee sign-in.

​
Choose a method

Ask your Confluence administrator which macros your site has. Do not paste the snippet into a normal Confluence code block. That shows the code instead of running it.

​
Option 1: Use the existing deployment snippet

  1. Open Website Search Widget settings.
  2. Select Basic usage, Public product mode, or Specific product ID to match your AI Search deployment.
  3. Copy the full snippet (container, external script, and initialization script).
  4. Edit the Confluence page, insert your HTML macro, and paste the snippet.
  5. Have your Confluence admin confirm the macro allows JavaScript and the external widget script.
  6. Publish, then test a question, a source link, a follow-up, and feedback.
For example, the HTML for Confluence Cloud macro supports JavaScript when enabled. For Data Center, see Atlassian’s JavaScript guidance.

​
Option 2: Embed a hosted page with the iFrame macro

Host a small HTML page with the same full snippet on a site that allows framing by your Confluence instance, then use its URL in the iFrame macro. Or use IrisAgent’s optional hosted page. External framing is off by default, so IrisAgent must deploy it and allow your exact Confluence HTTPS origin first.
  1. Ask IrisAgent to confirm the host is deployed and to allow your Confluence HTTPS origin.
  2. Copy the apiKey value from your Website Search Widget snippet.
  3. Edit the Confluence page and insert the iFrame macro.
  4. Set the URL, replacing YOUR_WIDGET_KEY:
  5. Start with width 800 and height 700 pixels, or use full width.
  6. Publish, then test a question, a source link, a follow-up, and feedback.
Keep the #apiKey=... fragment and URL-encode values with special characters. The fragment keeps the key out of the page request and referrer, but the key is still not a secret. See Atlassian’s iFrame macro instructions.

​
Product settings for the IrisAgent hosted page

  • Public product mode: append &usePublicProduct=true.
  • Specific product: append &productId=YOUR_PRODUCT_ID. This takes precedence over usePublicProduct.

​
Access and limits

Anyone can copy the shared widget key from the embed. Confluence page restrictions do not add authentication to the widget’s API. Neither method adds employee sign-in or per-user attribution.
  • Both methods use your existing AI Search widget, APIs, knowledge configuration, and billing. Make sure that configuration suits the people who will use it.
  • The widget does not read the Confluence page it sits on or an open Zendesk ticket. Include details in your question.
  • Source links keep their normal access requirements.

​
Troubleshooting

The snippet shows as text, or the HTML macro is blank. Make sure you used an HTML macro that runs JavaScript, not a code block. Ask your admin to allow scripts, the external widget script, and API requests. Otherwise, use Option 2. The hosted page will not display in the iFrame. Check that the URL has /agent-assist.html before the fragment and that IrisAgent has allowed your exact Confluence HTTPS origin. Framing is checked for every ancestor, so if your macro adds a vendor-hosted frame, IrisAgent must allow that origin too. Send IrisAgent your Confluence site URL and macro name. If framing is not possible, add a normal link to the same URL. The hosted page asks for an apiKey. Make sure the full #apiKey=... fragment was saved. Use the key from the AI Search snippet, not an employee login token. The widget loads but gives no answers. Check that the key and product settings match your working AI Search deployment and that the relevant knowledge has been ingested.