You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/guides/embed/box-embed.md
+62-10Lines changed: 62 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -176,11 +176,11 @@ In addition to embedding the complete Box Hub experience, you can embed only the
176
176
177
177
### Prerequisites
178
178
179
-
To embed a hub in AI Chat mode:
179
+
To access a hub embedded in AI Chat mode:
180
180
181
-
* The hub must have Box AI enabled.
182
-
*Users must be authenticated to interact with the chatbot.
183
-
*Users need at least Viewer [permissions][5] on the hub.
181
+
* The enterprise that owns the hub must have Box AI for Hubs enabled.
182
+
*The user must be authenticated and have Box AI for Hubs enabled at their enterprise.
183
+
*The user needs at least Viewer [permissions][5] on the hub.
184
184
185
185
### Creating an AI Chat embed
186
186
@@ -238,12 +238,63 @@ In **Chat widget** mode, the AI chat widget is embedded directly on page load. I
238
238
239
239
#### Chat widget parameters
240
240
241
-
When using the **Chat widget** mode, the generated `iframe` supports the following AI Chat-specific parameters in addition to standard `iframe` attributes:
241
+
In **Chat widget** mode, the AI chat widget is embedded directly on the page using an `iframe`. You can customize the behavior by adding URL parameters to the iframe's `src` attribute:
242
242
243
-
| Parameter | Required | Description |
244
-
|-----------|----------|-------------|
245
-
|`hub-id`| Yes | The ID of the hub that powers the chatbot. |
246
-
|`custom-box-domain`| No | For Box instances with custom domains. |
243
+
| Parameter | Description |
244
+
|-----------|-------------|
245
+
|`hubId`| The ID of the hub that powers the chatbot. |
246
+
|`sharedLink`| The shared link hash for hub access. If not provided, the chat loads only for users who are collaborators on the hub. |
247
+
|`showCloseButton`| Whether to show the [X (close) button][9]. Set to `false` if you want to implement custom opening/closing logic. Default: `true`. |
248
+
249
+
The following example shows a fully configured chat widget with all available parameters:
When embedding the Box AI chat directly via an `iframe` (without using the provided script), you can enable a close button within the chat interface that communicates with your parent application via `postMessage`.
267
+
268
+
##### Enabling the close button
269
+
270
+
To display a close button (✕) in the corner of the iframe, add the `showCloseButton=true` query parameter to your `iframe` URL as follows:
0 commit comments