Creating a Project

danger

Project creation is only available with a Master API Key or through the Dashboard/Projects. Since a Master API Key is the API Key with the highest permission level, please hide it securely so no one can access it directly.

In this section, we will show you how to create a Busy Hour Project.

Prerequisites

1. Busy Hour Account (Sign Up if you don't have one yet)
2. Generate a Master/Project API Key from Dashboard/Settings or from Dashboard/Projects

Creating a Project

To create a Busy Hour Project, you can use the project.create function from the @busy-hour/node package. The function take an object with the following properties:

Property	Type	Description
name	string	The name of the project
description	string (optional)	The description of the project

Quick Example

src/main.ts

import { BusyHourNode } from '@busy-hour/node';

// Create an instance of BusyHourNode with your API key (Master/Project)
const nodeSdk = new BusyHourNode({
  apiToken: 'your-api-token',
});

nodeSdk.project.create({
  payload: {
    name: 'your-new-project-name',
    description: null,
  },
});