About this integration
Manage files, folders, sharing, and editing sessions on a self-hosted ONLYOFFICE Docs (Community Server) instance. Use it from the workflow canvas with no custom glue script required.
This integration exposes 0 triggers, 32 search modules and 50 actions as workflow nodes. Authentication uses basic authentication.
How to connect
The credential form asks for Server URL and Authentication Token.
Prefer the interactive builder form? Open it on the app page.
Enter your credentials below. WEXTL stores them encrypted and uses them only to call the API on your behalf.
| Field | Type | Help |
|---|---|---|
Server URLRequired | text | The root URL of your self-hosted ONLYOFFICE Docs server, for example https://docs.example.com. |
Authentication TokenRequired | password | The authentication token for your server, sent as-is in the Authorization header (no "Bearer" prefix). Obtain it from your server administrator. |
Use it in workflow automation
Add Add Favorite Files and Folders as a workflow step.
Triggers, searches and actions
Use the tables below to inspect ONLYOFFICE Docs's 0 triggers, 32 search modules, and 50 actions.
Searches
Fetch data on demand using 32 search modules that query the app during a run.
- Check Files for Move Conflicts
- Get Active Operations
- Get Auto-Cleanup Setting
- Get Common Third-Party Services
- Get Conversion Status
27more searches
Actions
50 action modules cover the full range of create, update, and delete operations.
- Add Favorite Files and Folders
- Add Template Files
- Bulk Download Files
- Change Archive Format
- Change Default Access Rights
45more actions
Explore the fields available for each ONLYOFFICE Docs trigger, search, and action.
Searches
Input fields
| Field | Type |
|---|---|
Destination FolderRequired | choice |
File Ids | array |
Folder Ids | array |
Output fields
| Field | Type |
|---|---|
Conflicting Items | array |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Output fields
| Field | Type |
|---|---|
Auto-Cleanup Enabled | boolean |
Cleanup Interval | text |
Output fields
| Field | Type |
|---|---|
Id | text |
Title | text |
Parent Id | text |
Files Count | number |
Folders Count | number |
Created | text |
Updated | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Start If Not Started | boolean |
Output fields
| Field | Type |
|---|---|
Conversion Results | array |
Input fields
| Field | Type |
|---|---|
Include Version | boolean |
Output fields
| Field | Type |
|---|---|
Document Service Info | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Output fields
| Field | Type |
|---|---|
Download URL | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Version | number |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Output fields
| Field | Type |
|---|---|
Form Filling Properties | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Output fields
| Field | Type |
|---|---|
Shares | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Output fields
| Field | Type |
|---|---|
Versions | array |
Input fields
| Field | Type |
|---|---|
Exclude Trash | boolean |
Exclude Additional Folders | boolean |
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Sections | array |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
Output fields
| Field | Type |
|---|---|
Id | text |
Title | text |
Parent Id | text |
Files Count | number |
Folders Count | number |
Created | text |
Updated | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
Output fields
| Field | Type |
|---|---|
Path | array |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
Output fields
| Field | Type |
|---|---|
Shares | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Link IdRequired | text |
Password | secret |
Password Hash | text |
Output fields
| Field | Type |
|---|---|
Token | text |
Expires | text |
Two-Factor Required | boolean |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Access Level | number |
Output fields
| Field | Type |
|---|---|
Shared Link URL | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Is Folder | boolean |
Output fields
| Field | Type |
|---|---|
Subject Id | text |
Subject Name | text |
Link | text |
Access Level | number |
Entry Type | number |
Output fields
| Field | Type |
|---|---|
Providers | array |
Output fields
| Field | Type |
|---|---|
Provider Id | text |
Provider Key | text |
Title | text |
Corporate | boolean |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
User or Group ID | text |
Filter Type | number |
Search In Content | boolean |
Extension Filter | text |
Include Subfolders | boolean |
Output fields
| Field | Type |
|---|---|
Files | array |
Folders | array |
Start Index | number |
Count (this page) | number |
Total | number |
New Items | number |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Version | number |
Document Key | text |
Output fields
| Field | Type |
|---|---|
Document Type | text |
Type String | text |
Input fields
| Field | Type |
|---|---|
Search QueryRequired | text |
Limit | number |
Output fields
| Field | Type |
|---|---|
Id | text |
Title | text |
Access Level | number |
Shared | boolean |
Created | text |
Updated | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Tab Id | text |
Document Key | text |
Finish Session | boolean |
Doc Parameter | text |
Actions
Input fields
| Field | Type |
|---|---|
File Ids | array |
Folder Ids | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
File IdsRequired | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
File Ids | array |
Folder Ids | array |
Files to Convert | array |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
Use .tar.gzRequired | boolean |
Input fields
| Field | Type |
|---|---|
Access RightsRequired | array |
Output fields
| Field | Type |
|---|---|
Access Rights | array |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
VersionRequired | number |
Continue Previous Version | boolean |
Output fields
| Field | Type |
|---|---|
Versions | array |
Input fields
| Field | Type |
|---|---|
Document Server URLRequired | text |
Internal Document Server URL | text |
Community Server URL | text |
Output fields
| Field | Type |
|---|---|
Messages | array |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
New File TitleRequired | text |
Destination Folder | choice |
Convert to Fillable Form | boolean |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
Destination FolderRequired | choice |
File Ids | array |
Folder Ids | array |
Conflict Resolution | number |
Delete Source After Copy | boolean |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
File NameRequired | text |
File Size (Bytes)Required | number |
Relative Path | text |
Encrypted | boolean |
Output fields
| Field | Type |
|---|---|
Session | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
File TitleRequired | text |
Template Id | text |
Enable External Extension | boolean |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
File TitleRequired | text |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
Folder TitleRequired | text |
Output fields
| Field | Type |
|---|---|
Id | text |
Title | text |
Parent Id | text |
Files Count | number |
Folders Count | number |
Created | text |
Updated | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
Relative PathsRequired | array |
Output fields
| Field | Type |
|---|---|
Id | text |
Title | text |
Total Files | number |
Total Subfolders | number |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Delete Permanently | boolean |
Delete After Editing Session | boolean |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
File Ids | array |
Folder Ids | array |
Delete Permanently | boolean |
Delete After Editing Session | boolean |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
Delete Permanently | boolean |
Delete After Editing Session | boolean |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
File IdsRequired | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
Show Favorites FolderRequired | boolean |
Output fields
| Field | Type |
|---|---|
Enabled | boolean |
Input fields
| Field | Type |
|---|---|
Show Recent FolderRequired | boolean |
Output fields
| Field | Type |
|---|---|
Enabled | boolean |
Input fields
| Field | Type |
|---|---|
Show Templates FolderRequired | boolean |
Output fields
| Field | Type |
|---|---|
Enabled | boolean |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
File TitleRequired | text |
FileRequired | text |
Create New If Exists | boolean |
Keep Convert Status | boolean |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
File TitleRequired | text |
FileRequired | text |
Create New If Exists | boolean |
Keep Convert Status | boolean |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
File TitleRequired | text |
FileRequired | text |
Create New If Exists | boolean |
Keep Convert Status | boolean |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
URLRequired | text |
MethodRequired | choice |
Headers | array |
Header | object |
Query String | array |
Parameter | object |
Body | text |
Output fields
| Field | Type |
|---|---|
Body | text |
Headers | text |
Status Code | number |
Input fields
| Field | Type |
|---|---|
File Ids | array |
Folder Ids | array |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
Destination FolderRequired | choice |
File Ids | array |
Folder Ids | array |
Conflict Resolution | number |
Delete Source After Move | boolean |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
File Ids | array |
Folder Ids | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
File Ids | array |
Folder Ids | array |
Output fields
| Field | Type |
|---|---|
Success | boolean |
Input fields
| Field | Type |
|---|---|
ProviderRequired | choice |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Download URIRequired | text |
File Extension | text |
Force Save | boolean |
Document Key | text |
Content Stream | text |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
File PropertiesRequired | text |
Output fields
| Field | Type |
|---|---|
Form Filling Properties | text |
Input fields
| Field | Type |
|---|---|
File IdsRequired | array |
File PropertiesRequired | text |
Create Subfolder | boolean |
Output fields
| Field | Type |
|---|---|
Results | array |
Input fields
| Field | Type |
|---|---|
Provider KeyRequired | text |
Title | text |
Server URL | text |
Login | text |
Password | secret |
OAuth Token | secret |
Corporate Account | boolean |
Existing Provider | choice |
Output fields
| Field | Type |
|---|---|
Id | text |
Title | text |
Parent Id | text |
Files Count | number |
Folders Count | number |
Created | text |
Updated | text |
Input fields
| Field | Type |
|---|---|
Link KeyRequired | text |
Password Hash | text |
Is Folder | boolean |
Output fields
| Field | Type |
|---|---|
Result | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Access LevelRequired | number |
Notify Users | boolean |
Sharing Message | text |
Advanced Settings | text |
Output fields
| Field | Type |
|---|---|
Shares | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
Access LevelRequired | number |
Notify Users | boolean |
Sharing Message | text |
Output fields
| Field | Type |
|---|---|
Shares | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Output fields
| Field | Type |
|---|---|
Conversion Results | array |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
Edit Alone | boolean |
Output fields
| Field | Type |
|---|---|
Editing Key | text |
Input fields
| Field | Type |
|---|---|
Store Original FormatsRequired | boolean |
Output fields
| Field | Type |
|---|---|
Enabled | boolean |
Output fields
| Field | Type |
|---|---|
Operation Id | text |
Operation Type | number |
Progress | number |
Error | text |
Processed | text |
Finished | boolean |
Result URL | text |
Input fields
| Field | Type |
|---|---|
EnabledRequired | boolean |
Cleanup Interval | text |
Output fields
| Field | Type |
|---|---|
Auto-Cleanup Enabled | boolean |
Cleanup Interval | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
File ContentRequired | text |
File Extension | text |
Encrypted | boolean |
Force Save | boolean |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
FileRequired | choice |
New File Title | text |
Last Version Number | number |
Output fields
| Field | Type |
|---|---|
Name | text |
Updated | text |
Location | text |
Input fields
| Field | Type |
|---|---|
Update Existing VersionRequired | boolean |
Output fields
| Field | Type |
|---|---|
Enabled | boolean |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
New Folder TitleRequired | text |
Output fields
| Field | Type |
|---|---|
Id | text |
Title | text |
Parent Id | text |
Files Count | number |
Folders Count | number |
Created | text |
Updated | text |
Input fields
| Field | Type |
|---|---|
FolderRequired | choice |
FileRequired | text |
Create New If Exists | boolean |
Store Original Format | boolean |
Keep Convert Status | boolean |
Output fields
| Field | Type |
|---|---|
Uploaded File(s) | text |
Input fields
| Field | Type |
|---|---|
FileRequired | text |
Output fields
| Field | Type |
|---|---|
Uploaded File(s) | text |
Input fields
| Field | Type |
|---|---|
FileRequired | text |
Output fields
| Field | Type |
|---|---|
Uploaded File(s) | text |