Guide

Getting started with Vortask

This guide walks you through everything — from creating your first project to automating your workflow with the REST API and webhooks.

Create an account

Head to the registration page and enter your display name, email, and a password. Once registered you'll land directly on your projects page — no email confirmation required by default.

Steps

Go to vortask.app/register
Enter your display name, email address, and a password
Click Create account — you're in immediately

Your profile — display name and avatar — can be updated at any time from the Profile page.

Create a project

Each project gets its own Kanban board. You can create as many projects as you need — one per product, team, or quarter.

Steps

Open the Projects page after signing in
Click New project
Enter a project name and optional description
Click Create — the board opens immediately

The Board

Creating tasks

Every task belongs to a project and sits in one of four columns: New, Active, Blocked, or Closed. New tasks start in the New column.

Task fields

TitleRequired. Keep it short and actionable.

DescriptionOptional. Supports plain text detail.

PriorityLow, Medium, or High.

Due dateOptional deadline for the task.

TagsCustom labels for filtering (e.g. frontend, bug).

AssigneesOne or more project members.

Every change to a task — status, assignee, priority — is recorded in the task's history log with a timestamp and the user who made the change.

Moving tasks

Drag a task card and drop it into a different column to update its status. You can also open the task detail panel and change the status from the dropdown.

Status flow

NewActiveBlockedClosed

Tasks can move freely between any columns in any direction — the flow above is the typical progression.

Filters & search

Use the filter bar above the board to narrow down what you see. Filters are combinable — you can filter by priority and assignee at the same time.

PriorityShow only High, Medium, or Low tasks

AssigneeFilter to tasks assigned to a specific member

TagFilter by one or more custom tags

Due dateShow overdue or upcoming tasks

Team

Inviting members

Project Admins can invite teammates by email. An invitation email is sent with a link — when accepted, the person joins the project with the role you assigned.

Steps

Open your project and go to Members
Click Invite member
Enter the person's email and select a role
Click Send invitation — they'll receive an email link

Roles & permissions

Every project member has one of three roles.

Role	View	Create & edit tasks	Manage members
Admin	✓	✓	✓
Member	✓	✓	—
Viewer	✓	—	—

API

Generate a personal API token

Personal API tokens let you call the Vortask REST API from scripts, CI/CD pipelines, or any external tool. Tokens are prefixed with vt_ and stored as secure hashes — the full token is only shown once.

Steps

Go to your Profile page
Scroll to the API Tokens section
Click Generate new token and give it a name
Copy the token immediately — it won't be shown again

Store your token in an environment variable or secrets manager. Never commit it to source control.

Your first API call

All API requests go to https://localhost:7001/api in development. Pass your token in the Authorization header.

List your projects

curl

curl https://localhost:7001/api/projects \
  -H "Authorization: Bearer vt_your_token_here"

Example response

200 OK

[
  {
    "id": 1,
    "name": "Website Relaunch",
    "slug": "website-relaunch"
  }
]

The full API reference — every endpoint, request body, and response schema — is in the API Reference.

Managing tasks via API

Common task operations from the command line. Replace {projectId} and {taskId} with real IDs from your list response.

Create a task

POST/api/projects/{projectId}/tasks

curl -X POST https://localhost:7001/api/projects/1/tasks \
  -H "Authorization: Bearer vt_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Set up error monitoring",
    "priority": "High",
    "dueDate": "2026-04-01"
  }'

Close a task

PATCH/api/projects/{projectId}/tasks/{taskId}

curl -X PATCH https://localhost:7001/api/projects/1/tasks/42 \
  -H "Authorization: Bearer vt_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{ "status": "Closed" }'

Deleting tasks via the API is not permitted. Tasks can only be deleted from the board UI by an Admin.

Webhooks

Setting up a webhook

Webhooks send an HTTP POST to a URL you control whenever a task is created, updated, or closed. Use them to post notifications to Slack, trigger a CI pipeline, or sync data to another system.

curl -X POST https://localhost:7001/api/webhooks \
  -H "Authorization: Bearer vt_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-server.com/vortask-hook",
    "projectId": 1
  }'

Vortask will call your URL for every task event in that project. Your endpoint must return a 2xx response within 5 seconds.

Webhook payload

All events share the same payload shape. The event field tells you what happened.

POST to your endpoint

{
  "event": "task.updated",
  "projectId": 1,
  "task": {
    "id": 42,
    "title": "Set up error monitoring",
    "status": "Closed",
    "priority": "High",
    "assignees": [
      { "email": "jane@acme.com" }
    ]
  }
}

Event types

task.createdA new task was created

task.updatedAny task field was changed

task.closedTask status moved to Closed

Back to home API Reference