Clockify - Add a new project

Give Feedback | Bug report

Tags: #clockify #project #create #api #rest #documentation

Author: Florent Ravenel

Last update: 2023-05-17 (Created: 2023-05-17)

Description: This notebook will show how to add a new project using Clockify API to a specific workspace.

References:

Clockify API Documentation

Input

Import libraries

In [ ]:

import requests
import naas

Setup Variables

api_key: Get your API key
workspace_id: ID of the workspace
payload: Data of the project to be created

In [ ]:

api_key = naas.secret.get("CLOCKIFY_API_KEY") or "YOUR_API_KEY"
workspace_id = "626f9e3b36c2670314c0386e" #"<WORKSPACE_ID>"
payload = {
    "name": "My New Project",
    "note": "Notes",
    "public": True,
    "billable": True,
    "clientId": None,
    "color": "#000000",
}

Model

Create new project

This function will create a new project using Clockify API.

In [ ]:

def create_project(api_key, workspace_id, payload):
    url = f"https://api.clockify.me/api/v1/workspaces/{workspace_id}/projects"
    headers = {
        "X-Api-Key": api_key,
        "Content-Type": "application/json"
    }
    response = requests.post(url, headers=headers, json=payload)
    return response

Output

Display result

In [ ]:

response = create_project(api_key, workspace_id, payload)
if response.status_code == 201:
    print(f"✅ Project '{response.json().get('id')}' created to workspace")
else:
    print(f"❌ Error added new project")
response.json()