Introducing

Ideagen Community

Accessing Huddle API Methods

Follow

This article explains the different methods that can be used for accessing the Huddle API if you have this included with your account package:

  1. Authorization Code (Auth Code): In this method, you specify the client ID but log in using a user's credentials. 
  2. Client Credentials (Client Creds): With this approach, you log in using the client ID and its secret code without requiring a user login. However, it's important to note that certain workspace and file API commands are restricted to members of teams within workspaces, and this client ID cannot be added to these teams.
  3. Conversion of Client Credentials to include an email: This method is similar to method 2, but because it has an associated email address, it can be added to workspace teams. Consequently, it gains access to workspace and file API commands. To proceed with this method, we would need an email address that is Not already registered in Huddle and information about the client ID you are using.

The above methods require you to code scripts to utilise this and more information on how to do this is documented here Home · Huddle/huddle-apis Wiki · GitHub

There are also some fixed modules that allow you to access this without coding. These include:

  • Power Automate/Azure Logic Apps - This is where you can add various Huddle commands to a workflow in order to perform tasks. This is based on the Auth Code method so a user would need to login to this. 
    (Note: If you need to use the Client Creds with an email as means to access this, instead of the Auth Code, this will require you to have your own ClientId setup as per option 3 above and for you to develop the means to do to do this with Power Automate/Azure Logic Apps, as this falls outside the scope of Support.)

Symptoms

Note that if when trying to use the Client Creds method and messages like this are received: "{ "statusCode": 403, "errorMessages": [ "The user does not have permissions to view this document." ], "errorCode": "Authorization" }", this is usually a sign that Client Creds ClientId hasn't been converted to be associated with an email, as per point 3 above, or that they haven't assigned the email to the team on the workspace that would give the ClientId permissions to access the file.