Quickstart - Notion Docs

Get up and running with Workers in a few steps.

Prerequisites

Node.js

Version 22 or higher

npm

Version 10 or higher

Create your first worker

Install the CLI

curl -fsSL https://ntn.dev | bash

Initialize a new project

Scaffold a new worker project and enter the directory:

ntn workers new my-worker
cd my-worker

Deploy to Notion

Connect to your Notion workspace and deploy:

ntn workers deploy

Follow the prompts to authenticate with your Notion workspace.

Run the sample tool

Execute the included sample tool:

ntn workers exec sayHello -d '{"name": "World"}'

What’s in a worker?

The scaffolded project lives in src/index.ts and exports a single Worker instance:

src/index.ts

import { Worker } from "@notionhq/workers";

const worker = new Worker();
export default worker;

worker.tool("sayHello", {
  title: "Say Hello",
  description: "Returns a friendly greeting",
  schema: {
    type: "object",
    properties: {
      name: { type: "string" },
    },
    required: ["name"],
    additionalProperties: false,
  },
  execute: ({ name }) => `Hello, ${name}!`,
});