Boards API

isw-kudos · Mar 26, 2024 · 62bc2e0 · 62bc2e0
1 parent a4ac7b8
commit 62bc2e0
Show file tree

Hide file tree

Showing 10 changed files with 130 additions and 0 deletions.
diff --git a/docs/boards/api/advanced.png b/docs/boards/api/advanced.png
diff --git a/docs/boards/api/example.png b/docs/boards/api/example.png
diff --git a/docs/boards/api/index.md b/docs/boards/api/index.md
@@ -0,0 +1,41 @@
+# Using the Boards API
+
+Boards has a REST API that allows you to access and manage your boards data. The API documentation is available online from [Boards Cloud](https://boards.api.huddo.com) and also from your Boards deployment (including in-built Swagger documentation).
+
+The API is documented using OpenAPI (Swagger) and can be explored using the Swagger UI.
+
+[![example](./example.png)](https://boards.api.huddo.com)
+
+## Determine your API URL
+
+The API URL is based on your Boards deployment:
+
+-   Boards Cloud - [https://boards.api.huddo.com](https://boards.api.huddo.com)
+-   On-Premise - for example:
+
+    -   https://connections.company.com/api-boards/
+    -   https://boards-api.company.com
+
+## Authentication
+
+The API requires authentication via the user's API Token. To get your API Token:
+
+1. login to your Boards environment
+
+1. open the user menu, expand `Advanced`, and click `Huddo Boards API`
+
+    ![advanced](./advanced.png)
+
+1. copy the token
+
+    ![token](./token.png)
+
+1. include this token to requests to the Boards API in the `Authorization` header
+
+    For example:
+
+    - Method: `GET`
+    - URL: `https://<BOARDS_URL>/user/me`
+    - Headers: `Authorization: Bearer <token>`
+
+    ![postman](./postman.png)
diff --git a/docs/boards/api/postman.png b/docs/boards/api/postman.png
diff --git a/docs/boards/api/powerautomate.gif b/docs/boards/api/powerautomate.gif
diff --git a/docs/boards/api/powerautomate.md b/docs/boards/api/powerautomate.md
@@ -0,0 +1,23 @@
+# Huddo Boards Power Automate Integration
+
+!!! tip
+
+    This feature is only available for [Huddo Boards Cloud](https://boards.huddo.com).
+
+## What is Microsoft Power Automate?
+
+[Power Automate](https://www.microsoft.com/en-au/power-platform/products/power-automate) is a platform which allows end users to set up "Flows" which are workflows that connect two or more applications (like Huddo Boards). Each Flow consists of a "Trigger" and one or more "Actions". When the trigger event occurs, Power Automate automatically performs the actions.
+
+## Huddo Boards Connector
+
+Huddo Boards is now available as a [connector in Microsoft Power Automate](https://powerautomate.microsoft.com/en-au/connectors/details/shared_huddoboards/huddo-boards/). Create simple or complex flows to help you work across multiple applications and save time on repeatable tasks. Have you found a flow that works for you? Share it with us and we’ll turn it in to a template.
+
+![powerautomate example in action](./powerautomate.gif)
+
+## Triggers / Webhooks
+
+See the available [Triggers / Webhooks](https://learn.microsoft.com/en-au/connectors/huddoboards/#triggers).
+
+## Actions
+
+See the available [Actions](https://learn.microsoft.com/en-au/connectors/huddoboards/#actions).
diff --git a/docs/boards/api/token.png b/docs/boards/api/token.png
diff --git a/docs/boards/api/zapier.gif b/docs/boards/api/zapier.gif
diff --git a/docs/boards/api/zapier.md b/docs/boards/api/zapier.md
@@ -0,0 +1,62 @@
+# Huddo Boards Zapier Integration
+
+!!! tip
+
+    This feature is only available for [Huddo Boards Cloud](https://boards.huddo.com).
+
+## What is Zapier?
+
+[Zapier](https://zapier.com/) is a platform which allows end users to set up "Zaps" which are workflows that connect two or more applications (like Huddo Boards). Each Zap consists of a "Trigger" and one or more "Actions". When the trigger event occurs, Zapier automatically performs the actions.
+
+## Huddo Boards Zaps
+
+See the [Huddo Boards Zapier Integration](https://zapier.com/apps/huddo-boards/integrations) on the Zapier website.
+
+![example](./zapier.gif)
+
+## Triggers
+
+Huddo Boards provides a Zapier integration that allows you to trigger Zaps based on events in Boards. The following are some of the triggers which are available:
+
+| Trigger               | Description                                             |
+| --------------------- | ------------------------------------------------------- |
+| New Board             | Triggers when a new board is created.                   |
+| New Card              | Triggers when a new card is created.                    |
+| Assigned Task         | Triggers when a task is assigned to a user.             |
+| Task Completed        | Triggers when a task is completed.                      |
+| Member added to Board | Triggers when a member is added to a board.             |
+| My Task Completed     | Triggers when a task assigned to the user is completed. |
+
+## Actions
+
+Huddo Boards provides a Zapier integration that allows you to perform actions in Boards. The following are some of the actions which are available:
+
+| Action                                     | Description                                      |
+| ------------------------------------------ | ------------------------------------------------ |
+| Create Board                               | Creates a new board.                             |
+| Create Card                                | Creates a new card (entry/task in a Board).      |
+| Create Comment on Card                     | Adds a comment to a card.                        |
+| Assign Task to Member                      | Assigns a task to a member of the board.         |
+| Complete Task                              | Completes a task.                                |
+| Add Member to Board                        | Adds a member to a board.                        |
+| Find a Task by name and mark as complete   | Finds a task by name and marks it as complete.   |
+| Find a Task by name and mark as incomplete | Finds a task by name and marks it as incomplete. |
+| Move Card                                  | Moves a card to a different list or subtask.     |
+| Change Card or Board Dates                 | Change Start, End or Due dates on a Card / Board |
+
+## Searches
+
+Huddo Boards provides a Zapier integration that allows you to search for data in Boards. The following are some of the searchs which are available:
+
+| Search                                      | Description                                   |
+| ------------------------------------------- | --------------------------------------------- |
+| Find a Board by name                        | Finds a board by name.                        |
+| Find a Card in a Board by name              | Finds a card in a board by name.              |
+| Find a Task assigned to Me by name          | Finds a task assigned to the user by name.    |
+| Find Board Members                          | Gets all members of a board.                  |
+| Find a Board Member by name                 | Finds a member of a board by name.            |
+| Find all Cards in a Board                   | Gets all cards in a board.                    |
+| Find Comments on a Card                     | Gets all comments on a card.                  |
+| Find Me                                     | Gets the user details.                        |
+| Find User by name                           | Finds a user by name.                         |
+| Find a Board or Card URL in a block of text | Finds a Board or Card URL in a block of text. |
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -24,6 +24,10 @@ extra:
 nav:
   - Boards:
       - boards/index.md
+      - API: 
+          - boards/api/index.md
+          - Power Automate: boards/api/powerautomate.md
+          - Zapier: boards/api/zapier.md
       - Boards Cloud:
           - boards/cloud/index.md
           - Updates: boards/cloud/updates.md