API and webhooks

Use the Northstar API to access workspace data and build integrations with your own systems.

Webhooks let Northstar notify your application when important events happen.

Base URL

https://api.northstar.example/v1

Authentication

Northstar uses bearer tokens for API authentication.

Include your API token in the Authorization header.

Authorization: Bearer YOUR_API_TOKEN

Never include an API token in client-side JavaScript, public source code, screenshots, or documentation.

Create an API token

1. Open Settings.

2. Select Developers.

3. Select API tokens.

4. Select Create token.

5. Enter a descriptive name.

6. Select the permissions the token requires.

   

List projects

GET /projects

Example request:

curl https://api.northstar.example/v1/projects \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example response:

[CODE BLOCK]

{
  "data": [
    {
      "id": "prj_8f31k2",
      "name": "Customer Portal Launch",
      "status": "on_track",
      "target_date": "2026-09-30"
    }
  ]
}

Common response codes

Webhooks

Common webhook events include:

• project.created

• project.updated

• project.status_changed

• project.completed

• milestone.completed

Create a webhook

1. Open Settings.

2. Select Developers.

3. Select Webhooks.

4. Select Create webhook.

5. Enter your HTTPS endpoint.

6. Choose the events you want to receive.

7. Select Create.

   

Example webhook

{
  "event": "project.status_changed",
  "created_at": "2026-08-13T14:32:18Z",
  "data": {
    "project_id": "prj_8f31k2",
    "name": "Customer Portal Launch",
    "previous_status": "on_track",
    "status": "at_risk"
  }
}

Secure your webhook endpoint

We recommend that your endpoint:

• Uses HTTPS

• Verifies the Northstar webhook signature

• Responds quickly

• Handles duplicate events safely