wehub-resource-sync
55 lines
2.8 KiB
Markdown
55 lines
2.8 KiB
Markdown
# Description
|
|
|
|
Integrate your bot with Dropbox to list, manage, and transfer files seamlessly between Dropbox and the Botpress files API.
|
|
|
|
# Configuration
|
|
|
|
Currently, the Dropbox integration only supports OAuth authentication using your own Dropbox app.
|
|
|
|
## Configuring the integration with a custom app
|
|
|
|
1. Sign in to your Dropbox account and access the [Dropbox App Console](https://www.dropbox.com/developers/apps).
|
|
2. Create a new app by clicking the "Create app" button.
|
|
- Choose the "Scoped access" option.
|
|
- Give access to either a single folder or your entire Dropbox account.
|
|
- Name your app and click "Create app".
|
|
3. From your app's settings page, copy the **App Key** and **App Secret**. You will need these to configure the integration on Botpress.
|
|
4. In your app's Permissions page, add the following scopes:
|
|
- `account_info.read`
|
|
- `files.metadata.write`
|
|
- `files.content.read`
|
|
- `files.content.write`
|
|
- `sharing.read`
|
|
5. After adding the scopes, click the "Submit" button to apply the changes.
|
|
6. In your web browser, navigate to `https://www.dropbox.com/oauth2/authorize?response_type=code&token_access_type=offline&client_id=<App Key>`. **Make sure to replace `<App Key>` with the App Key you copied from step 3**.
|
|
- For example, if your **App Key** is `abcde`, the URL should end in `client_id=abcde`.
|
|
7. Authorize your Dropbox app to access your Dropbox account. You will then be presented with an **Access Code**. Copy this code.
|
|
8. On Botpress, enter your **App key**, **App secret**, and **Access Code** in the integration configuration page.
|
|
9. Save the configuration to enable the integration.
|
|
|
|
### Extra configuration for the File Synchronizer plugin
|
|
|
|
If you are using the File Synchronizer plugin, you need to set up a webhook in
|
|
your Dropbox app to receive real-time file change notifications.
|
|
|
|
1. On Botpress, copy the **Webhook URL** from the integration configuration page. This URL usually starts with `https://webhook.botpress.cloud/`.
|
|
2. From the Dropbox App Console, navigate to your app's settings page.
|
|
3. In the **Webhook** section, paste the **Webhook URL** you copied from Botpress and click `Add`.
|
|
4. Your bot should now be able to receive real-time file change notifications from Dropbox.
|
|
|
|
# Using the integration
|
|
|
|
The integration provides actions to manage your Dropbox files effectively:
|
|
|
|
- List files and folders in your Dropbox account
|
|
- Download files from Dropbox to your bot's storage
|
|
- Upload files from your bot to Dropbox
|
|
- Create, delete, and organize folders
|
|
- Move or copy files between locations
|
|
|
|
Use these actions in your workflows to seamlessly handle file operations between your bot and Dropbox.
|
|
|
|
# Limitations
|
|
|
|
Standard Dropbox API limitations apply. For more information, visit the [Dropbox API documentation](https://www.dropbox.com/developers/documentation).
|