Connectors / Service / Huddle

Cloud-based enterprise collaboration software (updated: 1507802650171)

Huddle

Team collaboration software for enterprise and government.

Overview

The Huddle connector allows you to interact with your Huddle workspace, seamlessly passing documents & folders between Huddle and your other SaaS tools.

Authentication

Within the workflow builder, highlight the Huddle connector.

In the Huddle connector properties panel to the right of the builder, click on the Authenticate tab and the 'Add new authentication' button.

add-auth

This will result in a Tray.io authentication pop-up modal. The first page will ask you to name your authentication and select the type of authentication you wish to create ('Personal' or 'Organisational').

As you can see, the next page asks you to select the "Environment". You can select either "Global" or "US" depending on your account type.

IMPORTANT: If you select US instance as your Environment, your account admin will need to reach out to help@huddle.com to request whitelisting the Tray US App. Global (.net) Huddle instances are preapproved.

huddle-popups

Once you select the "Environment", click on the 'Create authentication' button it will redirect you to login to your Huddle account.

Add your username and password details and grant permission for Tray.io to access the account information.

huddle-auth-2

Once you are signed in successfully into your Huddle account.

Go back to your settings authentication field (within the workflow builder properties panel), and select the recently added authentication from the dropdown options now available.

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Example Usage

Below is an example of a way in which you could potentially use the Huddle connector, to get a workspace with a given workspace ID.

The steps will be as follows:

  1. Setup using a manual trigger and list all workspace in your account.

  2. Add the Loop collection connector to iterate over each workspace.

  3. Gather the information available for each workspace.

The final outcome should look like this:

huddle-complete-workflow

1 - Setup Trigger & List workspaces

Once you have clicked 'Create new workflow' from your main Tray.io dashboard named it, select the Manual trigger from the trigger options available:

huddle-manual-trigger

After you have been redirected to the Tray.io workflow dashboard, from the connectors panel on the left, add a Huddle connector to your second step. Set the operation to 'List worksapces'.

huddle-step-1

Feel free to re-name your steps as you go along to make things clearer for yourself and other users.

Now when this workflow is run, it will pull down a list of worksapces from your Huddle account.

2 - Add a loop collection

Next, search for the 'Loop collection' connector within your connector panel, and drag it into your workflow as your next step. Set your operations to 'Loop list'.

The Loop Collection connector allows you to iterate through a list of results. In this example, we will use it to iterate through the data found within the previous Huddle connector step.

In order to specify the list you want to loop through, start by using the 'List' mapping icon (found next to the list input field, within the properties panel) to generate the connector-snake.

While hovering over the 'List worksapces' step (with the tail end of the connector-snake), select workspaces from the list of output properties displayed. This will auto-populate a jsonpath within your 'List' input field, and update the type selector to jsonpath.

For more clarification on the pathways you have available, open the Debug panel to view your step's Input and Output.

JSONPATHS: For more information on what jsonpaths are and how to use jsonpaths with Tray.io, please see our Intro page and Data Guide for more details.

CONNECTOR-SNAKE: The simplest and easiest way to generate your jsonpaths is to use our feature called the Connector-snake. Please see the main page for more details.

huddle-step-2-loop

This will enable us to iterate over the list of worksapces, and perform operations for each one, during each loop cycle.

4 - Get a single workspace information

The last step is to drag a Huddle connector inside of the Loop Collection step itself. Set the operation to 'Get workspace'. As you can see, the 'Workspace ID' field is required.

Use the same connector-snake method for generating the JSON path to get the 'Workspace ID' field.

huddle-step-3

Once the workflow run, you will be able to gather the information available for each workspace.

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

2.0

Copy document

Copy a document to a different folder in Huddle.

Create workspace

Create a new workspace.

Delete Document

Delete a document from one of your Huddle workspaces.

Download Document

Download a Huddle document by id

Create Document

Create a new Document

Create Folder

Create a new folder.

Create or Update Folder

Update a folder within a directory if it exists, create it if it doesn't.

Create team

Create a team for a given workspace.

Find folder by title

Search a folder to find a folder in a directory with the specified title. If found, it is returned.

Folder exists?

Check to see if a folder exists, using it's unique ID.

Get Document

Get a document's details by id

Get Folder

Get a folder by ID.

Get User

Get a huddle user by their id

Get Workspace

Get a workspace by id

Get account ID

Retrieve the account ID of the current user.

List Approvals (manager only)

Get a list of all of the OPEN approvals in a Huddle workspace. Any approvals containing at least one open assignment will be returned. Note that you must be a workspace manager to get a list of approvals.

List Document Approvals

Get a list of all of the approvals for a document.

List folder documents & folders

For a given folder, get a paged list of documents and folders within that folder.

Move folder

Move a folder to a new location.

List folders

Get a list of all of the folders in workspace, or optionally in a particular folder within that workspace.

Update folder

Update a folder's details, including the title and description.

List teams

List teams in a workspace.

List teams DDL

List workspace members DDL

List workspaces

Get a list of all of the workspaces that you (the authenticated user) have access to.

List workspaces DDL

Move document

Move a document to a different folder in Huddle.