diff --git a/content/guides/box-ai/ai-agents/get-agent-default-config.md b/content/guides/box-ai/ai-agents/get-agent-default-config.md index 3fb92dad5..6b0b58a9b 100644 --- a/content/guides/box-ai/ai-agents/get-agent-default-config.md +++ b/content/guides/box-ai/ai-agents/get-agent-default-config.md @@ -27,7 +27,7 @@ To send a request, use the `GET /2.0/ai_agent_default` endpoint. Make sure you have generated the developer token -to authorize your app. See [prerequisites for using Box AI][prereq] +to authorize your app. See [getting started with Box AI][prereq] for details. diff --git a/content/guides/box-ai/ai-tutorials/ask-questions.md b/content/guides/box-ai/ai-tutorials/ask-questions.md index fbe9ee6ba..fb8102dff 100644 --- a/content/guides/box-ai/ai-tutorials/ask-questions.md +++ b/content/guides/box-ai/ai-tutorials/ask-questions.md @@ -28,7 +28,7 @@ you can ask Box AI to summarize the content. ## Before you start -Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate. +Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate. ## Send a request diff --git a/content/guides/box-ai/ai-tutorials/default-agent-overrides.md b/content/guides/box-ai/ai-tutorials/default-agent-overrides.md index a5884b7f3..9f7936d9e 100644 --- a/content/guides/box-ai/ai-tutorials/default-agent-overrides.md +++ b/content/guides/box-ai/ai-tutorials/default-agent-overrides.md @@ -23,7 +23,7 @@ Endpoints related to metadata extraction are currently a beta feature offered su ## Before you start -Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate. +Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate. To get more context, read about [agent overrides][agent-overrides]. ## Override prompt diff --git a/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md b/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md index b14ebc95b..eddb4c6dc 100644 --- a/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md +++ b/content/guides/box-ai/ai-tutorials/extract-metadata-structured.md @@ -26,7 +26,7 @@ To learn more about creating templates, see [Creating metadata templates in the ## Before you start -Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate. +Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate. ## Send a request diff --git a/content/guides/box-ai/ai-tutorials/extract-metadata.md b/content/guides/box-ai/ai-tutorials/extract-metadata.md index 35333af48..d71e3107b 100644 --- a/content/guides/box-ai/ai-tutorials/extract-metadata.md +++ b/content/guides/box-ai/ai-tutorials/extract-metadata.md @@ -24,7 +24,7 @@ Box AI API allows you to query a document and extract metadata based on a provid ## Before you start -Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate. +Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate. ## Send a request diff --git a/content/guides/box-ai/ai-tutorials/generate-text.md b/content/guides/box-ai/ai-tutorials/generate-text.md index c3cc55cbc..5a5051643 100644 --- a/content/guides/box-ai/ai-tutorials/generate-text.md +++ b/content/guides/box-ai/ai-tutorials/generate-text.md @@ -28,7 +28,7 @@ based on provided content. ## Before you start -Make sure you followed the steps listed in [prerequisites for using Box AI][prereq] to create a custom app and authenticate. +Make sure you followed the steps listed in [getting started with Box AI][prereq] to create a custom app and authenticate. ## Send a request diff --git a/content/guides/embed/box-embed.md b/content/guides/embed/box-embed.md index 0b9bc4826..c6ed5c9c1 100644 --- a/content/guides/embed/box-embed.md +++ b/content/guides/embed/box-embed.md @@ -34,7 +34,7 @@ To fetch the Box Embed widget code from the Box web app, perform the following s 1. Navigate to the chosen Hub. 2. Click on the ellipsis menu in the top right corner. -3. Click **Embed Widget**. +3. Click **Embed Hub**. ![Box Embed](./box-embed-new.png) diff --git a/content/guides/events/user-events/for-user.md b/content/guides/events/user-events/for-user.md index 797ede686..3a062f87a 100644 --- a/content/guides/events/user-events/for-user.md +++ b/content/guides/events/user-events/for-user.md @@ -79,10 +79,12 @@ The following events are available in all feeds. | `LOCK_DESTROY` | A file was unlocked. If a locked file is deleted, the source file will be null. | | `ITEM_TRASH` | A file or folder was marked as deleted | | `ITEM_UNDELETE_VIA_TRASH` | A file or folder was recovered out of the trash | -| `COLLAB_ADD_COLLABORATOR` | A collaborator was added to a folder | +| `COLLAB_ADD_COLLABORATOR` | A collaborator was added to a folder + + | | `COLLAB_ROLE_CHANGE` | A collaborator had their role changed | | `COLLAB_INVITE_COLLABORATOR` | A collaborator was invited on a folder | -| `COLLAB_REMOVE_COLLABORATOR` | A collaborator was removed from a folder | +| `COLLAB_REMOVE_COLLABORATOR` | A collaborator was removed from a folder | | `ITEM_SYNC` | A folder was marked for sync | | `ITEM_UNSYNC` | A folder was unmarked for sync | | `ITEM_RENAME` | A file or folder was renamed | @@ -96,18 +98,28 @@ The following events are only available in the `all` feed. |--------------------------|-----------------------------------------------------------| | `COMMENT_CREATE` | A comment was created on a folder, file, or other comment | | `COMMENT_DELETE` | A comment was deleted on folder, file, or other comment | -| `ITEM_DOWNLOAD` | A file or folder was downloaded | -| `ITEM_PREVIEW` | A file was previewed | +| `ITEM_DOWNLOAD` | A file or folder was downloaded | +| `ITEM_PREVIEW` | A file was previewed | | `TASK_ASSIGNMENT_CREATE` | A task was assigned | | `TASK_CREATE` | A task was created | | `ITEM_SHARED_CREATE` | A file or folder was enabled for sharing | | `ITEM_SHARED_UNSHARE` | A file or folder was disabled for sharing | | `ITEM_SHARED` | A folder was shared | | `TAG_ITEM_CREATE` | A Tag was added to a file or folder | -| `ENABLE_TWO_FACTOR_AUTH` | 2 factor authentication enabled by user. | -| `MASTER_INVITE_ACCEPT` | Free user accepts invitation to become a managed user. | -| `MASTER_INVITE_REJECT` | Free user rejects invitation to become a managed user. | -| `ACCESS_GRANTED` | Granted Box access to account. | -| `ACCESS_REVOKED` | Revoke Box access to account. | +| `ENABLE_TWO_FACTOR_AUTH` | 2 factor authentication enabled by user | +| `MASTER_INVITE_ACCEPT` | Free user accepts invitation to become a managed user | +| `MASTER_INVITE_REJECT` | Free user rejects invitation to become a managed user | +| `ACCESS_GRANTED` | Granted Box access to account | +| `ACCESS_REVOKED` | Revoke Box access to account | + +## Event notifications + +To reduce the noise of the event stream and optimize event consumption, the event types listed in the table trigger a limited number of notifications. + +| Event type | Notification behavior| +|-----------|--------------| +|`COLLAB_ADD_COLLABORATOR`, `COLLAB_REMOVE_COLLABORATOR`, `COLLAB_INVITE_COLLABORATOR`, `COLLAB_ROLE_CHANGE` | When these events take place, the content owner on the `changes` event stream is notified. Collaborators see an additional event that matches what they see on the `all` stream.| +| `ITEM_DOWNLOAD` | When an item is downloaded, only the content owner gets the notification. Collaborators are not notified.| +| `ITEM_PREVIEW` | When an item is previewed, only the content owner gets the notification. Collaborators are not notified. | [longpoll]: g://events/user-events/polling