HacknPlan
With HacknPlan modules in Boost.space Integrator, you can watch, create, update, retrieve, list, and delete:
-
projects
-
boards
-
milestones
-
work items
-
project users
To get started with HacknPlan, create an account at hacknplan.com.
Connect HacknPlan to Boost.space Integrator
To connect HacknPlan app, you need to obtain the API Key values from your HacknPlan account and insert them in the HacknPlan module scenario.
-
Log in to your HacknPlan account.
-
Click Profile > Settings > API Beta > Create.
-
Enter a name for the label and select the scopes. Click Create.
-
Copy the API key to a safe place.
-
Log in to your Boost.space Integrator account, insert a HacknPlan module scenario and click the Add button next to the Connection field.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the details copied in step 4 and click Save.
You have successfully established the connection. You can now begin editing your scenario and adding more HacknPlan modules. If your connection needs reauthorization at any point, follow the connection renewal steps here.
Projects
You can watch, create, update, retrieve, list, and delete projects using the following modules.
Watch Projects
Triggers when a new project is created.
Connection
Establish a connection to your HacknPlan account.
Limit
Set the maximum number of projects Boost.space Integrator will return during one execution cycle. The default value is 2.
List Projects
Gets all the projects the authenticated user is a member of.
Connection
Establish a connection to your HacknPlan account.
Limit
Set the maximum number of projects Boost.space Integrator will return during one execution cycle. The default value is 2.
Get a Project
Gets a project.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose details you want to retrieve.
Create a Project
Creates a new project.
Connection
Establish a connection to your HacknPlan account.
For field descriptions, see the HacknPlan Projects API reference.
Update a Project
Updates a project partially.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose details you want to update.
For field descriptions, see the HacknPlan Projects API reference.
Delete a Project
Deletes a project.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID you want to delete.
Boards
You can watch, create, update, retrieve, list, and delete boards using the following modules.
Watch Boards
Triggers when a new board in the project is created.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose boards you want to watch.
Limit
Set the maximum number of boards Boost.space Integrator will return during one execution cycle. The default value is 10.
List Boards
Gets a list of all boards in the project.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose boards you want to list.
Include Closed
Select whether to include the closed boards.
Limit
Set the maximum number of boards Boost.space Integrator will return during one execution cycle. The default value is 10.
Get a Board
Gets a board.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose boards you want to retrieve.
Board ID
Select or map the Board ID whose details you want to retrieve.
Create a Board
Creates a new board.
Connection
Establish a connection to your HacknPlan account.
For field descriptions, see the HacknPlan Boards API reference.
Update a Board
Updates a board partially.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose boards you want to update.
Board ID
Select or map the Project ID whose details you want to update.
For field descriptions, see the HacknPlan Boards API reference.
Delete a Board
Deletes a board.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose board you want to delete.
Board ID
Select or map the Board ID you want to delete.
Remove Work Items
Select whether to remove work items.
Milestones
You can watch, create, update, retrieve, list, close, reopen, and delete milestones using the following modules.
Watch Milestones
Triggers when a new milestone in the project is created.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose milestones you want to watch.
Include Boards
Select whether to include the boards.
Limit
Set the maximum number of milestones Boost.space Integrator will return during one execution cycle. The default value is 2.
List Milestones
Gets a list of the milestones in the project.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose milestones you want to list.
Include Boards
Select whether to include the boards.
Include Closed
Select whether to include the closed milestones.
Limit
Set the maximum number of milestones Boost.space Integrator will return during one execution cycle. The default value is 10.
Get a Milestone
Gets a milestone.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose milestones you want to retrieve.
Milestone ID
Select or map the Milestone ID whose details you want to retrieve.
Include Boards
Select whether to include the boards.
Create a Milestone
Creates a new milestone.
Connection
Establish a connection to your HacknPlan account.
For field descriptions, see the HacknPlan Milestones API reference.
Update a Milestone
Updates a milestone partially.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose milestones you want to update.
Milestone ID
Select or map the Milestone ID whose details you want to update.
For field descriptions, see the HacknPlan Milestones API reference.
Close a Milestone
Closes a milestone.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose milestones you want to close.
Milestone ID
Select or map the Milestone ID you want to close.
Close Boards
Select whether to close the boards.
Close Tasks
Select whether to close the tasks.
Reopen a Milestone
Reopens a milestone.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose milestones you want to reopen.
Milestone ID
Select or map the Milestone ID you want to reopen.
Delete a Milestone
Deletes a milestone.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose milestones you want to delete.
Milestone ID
Select or map the Milestone ID you want to delete.
Delete Boards
Select whether to delete the boards.
Work Items
You can watch, create, update, search, retrieve, and delete work items using the following modules.
Watch Work Items
Triggers when a new work item is created or updated.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose work items you want to watch.
Watch
Select or map the events you want to watch. For example, created.
Limit
Set the maximum number of work items Boost.space Integrator will return during one execution cycle. The default value is 2.
Search Work Items
Searches for work items or lists them all.
Connection
Establish a connection to your HacknPlan account.
Limit
Set the maximum number of work items Boost.space Integrator will return during one execution cycle. The default value is 10.
See the HacknPlan Work Items API reference for entering the field values to search for the work items that match the specified value.
Get a Work Item
Gets a work item.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose work items you want to retrieve.
Work Item ID
Select or map the Work Item ID whose details you want to retrieve.
Create a Work Item
Creates a new work item.
Connection
Establish a connection to your HacknPlan account.
For field descriptions, see the HacknPlan Work Items API reference.
Update a Work Item
Updates a work item partially.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose work items you want to update.
Work Item ID
Select or map the Work Item ID whose details you want to update.
For field descriptions, see the HacknPlan Work Items API reference.
Delete a Work Item
Deletes a work item.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose work items you want to delete.
Work Item ID
Select or map the Work Item ID you want to delete.
Project Users
You can watch, add, update, retrieve, list, and remove users from a project using the following modules.
List Project Users
Gets a list of users of a project.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose users you want to list.
Include Inactive
Select whether to include inactive users.
Include Guests
Select whether to include inactive guest users.
Limit
Set the maximum number of work items Boost.space Integrator will return during one execution cycle. The default value is 10.
Get a Project User
Gets a project user.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose users you want to retrieve.
User ID
Select or map the User ID whose details you want to retrieve.
Add a User to a Project
Adds a new user to aproject.
Connection
Establish a connection to your HacknPlan account.
For field descriptions, see the HacknPlan Project Users API reference.
Update a Project User
Updates a project user partially.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose users you want to update.
User ID
Select or map the User ID whose details you want to update.
For field descriptions, see the HacknPlan Project Users API reference.
Remove a User from a Project
Removes a user from a project.
Connection
Establish a connection to your HacknPlan account.
Project ID
Select or map the Project ID whose users you want to remove.
User ID
Select or map the User ID you want to remove.
Other
You can call APIs using the following module.
Make an API Call
Performs an arbitrary authorized API call.
For the list of available endpoints, refer to the HacknPlan API documentation.
Connection
Establish a connection to your HacknPlan account.
URL
Enter a path relative to https://api.hacknplan.com. For example, /v0/users/me.
Method
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of use – List Boards
The following API call returns all boards from a specific project of your account.
URL: /v0/projects/{projectId}/boards
Method: GET
Matches of the search can be found in the module’s Output under Bundle > Body.
In our example, 5 boards were returned:
Legacy article, imported from the original Boost.space knowledge base (/knowledge-base/applications/productivity/hacknplan/).
