Huddle is a secure document collaboration and client portal trusted by Enterprise and Government alike.
Status: Preview |
Tier: Premium |
Version: 2.0 |
Name |
Summary |
Upload a form submission as a text file |
|
Retrieve the content and metadata of a file using its ID |
|
Delete a target folder using its ID |
|
Retrieve a folder by it's ID |
|
CreateFolder (string folderId, [Optional]FolderInput requestBody) |
Create a new subfolder |
Retrieve a list of all of the subfolders within a target folder |
|
UploadFile (string workspaceId, string folderId, [Optional]FileUpload requestBody) |
Create and upload a new file to a target folder |
Update a task's status to completed using it's ID |
|
List available workspaces |
|
Get Workspace Paths |
|
Get the root folder contents of a workspace |
|
CreateWorkspaceTask (string workspaceId, [Optional]TaskInputs requestBody) |
Create a To-Do task in a target workspace |
Name |
Summary |
PollFolderForFileUpload (string workspaceId, string folderId, [internal][Optional]string after) |
Poll a target folder for it's most recent upload |
PollWorkspaceForNewApproval (string workspaceId, [internal][Optional]string after) |
Poll a target workspace for it's most recent approval request |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Upload a form submission as a text file
Description: Upload a form submission as a text file
Syntax:
Huddle.UploadFormSubmissionAsNewFile (string workspaceId, string folderId, [Optional]TextFileUpload requestBody)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceId |
string (Workspace) |
The workspace where the file will be uploaded |
True |
|
folderId |
string (Target Folder) |
The folder where the file will be uploaded |
True |
|
requestBody |
|
|
False |
Returns:
Type:UploadFormSubmissionAsNewFileResponse
Summary: Retrieve the content and metadata of a file using its ID
Description: Get the content of a file by ID
Syntax:
Huddle.GetFile (string fileId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
fileId |
string (File ID) |
The ID of the file to get |
True |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file.
Summary: Delete a target folder using its ID
Description: Delete a folder by ID
Syntax:
Huddle.DeleteFolder (string folderId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folderId |
string (Folder) |
The ID of the folder to delete |
True |
Returns:
Type:DeleteFolderResponse
Summary: Retrieve a folder by it's ID
Description: Gets a folder by ID from the Huddle API
Syntax:
Huddle.GetFolder (string folderId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folderId |
string (Folder) |
The ID of the folder to get |
True |
Returns:
Type:Folder
Summary: Create a new subfolder
Description: Creates a new folder within the target folder
Syntax:
Huddle.CreateFolder (string folderId, [Optional]FolderInput requestBody)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folderId |
string (Folder) |
The ID of the folder in which the new one will be created |
True |
|
requestBody |
|
|
False |
Returns:
Type:Folder
Summary: Retrieve a list of all of the subfolders within a target folder
Description: Lists the child folders contained within the target folder
Syntax:
Huddle.GetChildFolders (string folderId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
folderId |
string (Folder) |
The ID of the parent folder |
True |
Returns:
Type:array of (Folder)
Summary: Create and upload a new file to a target folder
Description: Uploads a file to the target folder
Syntax:
Huddle.UploadFile (string workspaceId, string folderId, [Optional]FileUpload requestBody)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceId |
string (Workspace) |
The workspace where the file will be uploaded |
True |
|
folderId |
string (Target Folder) |
The folder to target for file upload |
True |
|
requestBody |
|
|
False |
Returns:
Type:UploadFileResponse
Summary: Update a task's status to completed using it's ID
Description: Update a task's status to completed
Syntax:
Huddle.MarkTaskComplete (string taskId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
taskId |
string (Task ID) |
The ID of the task to mark as complete |
True |
Returns:
Type:Task
Summary: List available workspaces
Description: Get an array of available workspaces
Syntax:
Huddle.GetWorkspaces ()
Returns:
Summary: Get Workspace Paths
Description: Get two level depth path listing
Syntax:
Huddle.GetWorkspacePaths (string workspaceId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceId |
string
|
|
True |
Returns:
Type:GetWorkspacePathsResponse
Summary: Get the root folder contents of a workspace
Description: Get the contents of the workspace root folder
Syntax:
Huddle.GetRootFolderContents (string workspaceId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceId |
string (Workspace) |
The workspace to get the root folder of |
True |
Returns:
Type:array of (Folder)
Summary: Create a To-Do task in a target workspace
Description: Creates a To-Do in a workspace
Syntax:
Huddle.CreateWorkspaceTask (string workspaceId, [Optional]TaskInputs requestBody)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceId |
string (Workspace) |
The workspace to create the task in |
True |
|
requestBody |
|
|
False |
Returns:
Type:CreateWorkspaceTaskResponse
Summary: Poll a target folder for it's most recent upload
Description: Poll a target folder for it's most recent upload
Syntax:
Huddle.PollFolderForFileUpload (string workspaceId, string folderId, [internal][Optional]string after)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceId |
string (Workspace) |
The workspace to watch a folder in |
True |
|
folderId |
string (Target Folder) |
The folder to watch |
True |
|
after |
string
|
|
False |
Returns:
Type:PollFolderForFileUploadResponse
Summary: Poll a target workspace for it's most recent approval request
Description: Poll a target workspace for it's most recent approval request
Syntax:
Huddle.PollWorkspaceForNewApproval (string workspaceId, [internal][Optional]string after)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
workspaceId |
string (Workspace) |
The workspace to watch a folder in |
True |
|
after |
string
|
|
False |
Returns:
Type:PollWorkspaceForNewApprovalResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
name |
string Assignee Name |
Assignee name |
|
string Assignee Email |
Assignee email |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
deleted |
boolean
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
contentType |
string Type |
The file's document MIME type |
created |
string(date) File Created |
The date and time the file was created |
description |
string Description |
A description of the file |
extension |
string Extension |
The file's extension |
folderId |
string Folder ID |
ID of the folder in which the file resides |
id |
string File ID |
The file's ID |
title |
string Title |
The file's title |
updated |
string(date) Last Updated |
The date and time the file was last updated |
workspaceId |
string Workspace ID |
The ID of the workspace in which the file resides |
Summary:
Description:
Properties:
Name |
Type |
Summary |
content |
string(binary) File content |
The binary content of the file |
description |
string Description |
A description of the file |
title |
string Title |
The file's title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
children |
array of (ChildrenItem) Child folders ( Subfolders ) |
The child folders contained within the current one |
description |
string Description |
Description |
files |
array of (File) Files |
The documents and files contained within the current one |
id |
string Folder ID |
The ID of the folder |
title |
string Title |
The title of the folder |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
title |
string Title |
The title of the folder |
description |
string Description |
Description |
Summary:
Description:
Properties:
Name |
Type |
Summary |
paths |
array of (PathsItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string
|
|
path |
string
|
|
title |
string
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
workspaces |
array of (Workspace)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
assignees |
array of (Assignee) Approval Assignees |
An array of assigned users |
assignerName |
string Approval Requester Name |
Name of the approval requester |
assignerEmail |
string Approval Requester Email |
Email of the approval requester |
ownerName |
string Approval Task Owner Name |
Name of the approval task owner |
ownerEmail |
string Approval Task Owner Email |
Email of the approval task owner |
description |
string Description |
A description of the task |
dueDate |
string Due Date |
The date by which the task should be completed |
created |
string Created Date |
The created date for the approval task |
fileId |
string File ID |
The ID of the file the task is associated with, if any |
fileTitle |
string File Title |
The file's title |
id |
string Approval Task ID |
The ID of the Approval task |
status |
string Status |
The task's status |
type |
string Task Type |
The type of task |
workspaceId |
string Workspace ID |
The ID of the workspace for the given Approval task |
workspaceName |
string Workspace Name |
The name of the workspace for the given Approval task |
Summary:
Description:
Properties:
Name |
Type |
Summary |
files |
array of (UploadFileTriggerOutput)
|
files |
Summary:
Description:
Properties:
Name |
Type |
Summary |
approvals |
array of (NewApprovalTriggerOutput)
|
approvals |
Summary:
Description:
Properties:
Name |
Type |
Summary |
assignee |
string Assignee |
The ID of user to whom the task is assigned, if any |
description |
string Description |
A description of the task |
dueDate |
string Due Date |
The date by which the task should be completed |
fileId |
string File ID |
The ID of the file the task is associated with, if any |
id |
string Task ID |
The ID of the task |
status |
string Status |
The task's status |
title |
string Title |
The task's title |
type |
string Type |
The type of task |
workspaceId |
string Workspace ID |
The ID of the workspace the task resides in |
Summary:
Description:
Properties:
Name |
Type |
Summary |
assignee |
string Assignee |
The ID of user to whom the task is assigned, if any |
description |
string Description |
A description of the task |
dueDate |
string Due Date |
The date by which the task should be completed |
fileId |
string File ID |
The ID of the file the task is associated with, if any |
id |
string Task ID |
The ID of the task |
status |
string Status |
The task's status |
title |
string Title |
The task's title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
content |
string Text Content |
Text content (with multi-line) for upload |
description |
string Description |
A description of the file |
title |
string Title |
The file's title |
Summary:
Description:
Properties:
Name |
Type |
Summary |
file |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
created |
string(date) File Created |
The date and time the file was created |
description |
string Description |
A description of the file |
folderId |
string Folder ID |
ID of the folder in which the file resides |
id |
string File ID |
The file's ID |
title |
string Title |
The file's title |
updated |
string(date) Last Updated |
The date and time the file was last updated |
workspaceId |
string Workspace ID |
The ID of the workspace in which the file resides |
Summary:
Description:
Properties:
Name |
Type |
Summary |
file |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
files |
array of (FilesItem) Files |
Files in the workspace's root directory |
folders |
array of (FoldersItem) Folders |
Folders in the workspace's root directory |
id |
string Workspace ID |
The ID of the workspace |
title |
string Title |
The title of the workspace |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |