whatisgithub

What is notion-workx?

ravenrepo/notion-workx — explained in plain English

Analysis updated 2026-05-18

0TypeScriptAudience · developerComplexity · 3/5LicenseSetup · moderate

In one sentence

A code generator that turns an OpenAPI spec into a deployable Notion Worker project, mapping each API endpoint to a callable tool automatically.

Mindmap

mindmap
  root((WorX))
    What it does
      Reads OpenAPI spec
      Generates worker code
      Maps endpoints to tools
    Tech stack
      TypeScript
      Notion Workers
      OpenAPI 3.x
    Use cases
      Turn API into Notion tool
      Automate worker creation
      Split large APIs by tag
    Audience
      Notion developers
      API integrators
    Limitations
      No remote refs
      No OAuth2 automation
      Skips binary uploads

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Turn an existing REST API's OpenAPI spec into a working Notion Worker without hand-writing each tool.

USE CASE 2

Quickly prototype a Notion integration for an API you already document with OpenAPI.

USE CASE 3

Split a large API into multiple smaller Notion Workers using tag filters to stay under the tool cap.

USE CASE 4

Generate a starter worker project as a base to customize further by hand.

What is it built with?

TypeScriptNode.jsOpenAPINotion Workers

How does it compare?

ravenrepo/notion-workx0xradioac7iv/tempfsabboskhonov/hermium
Stars000
LanguageTypeScriptTypeScriptTypeScript
Setup difficultymoderatemoderatemoderate
Complexity3/53/54/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · moderate Time to first run · 30min

Requires Notion Workers enabled in your workspace plus an OpenAPI spec to generate from.

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

So what is it?

WorX is a code generator that turns an OpenAPI 3.x specification into a ready to deploy Notion Worker project. If you already have an API described in an OpenAPI file (a common format that documents what endpoints an API offers and what data they expect), WorX reads that file and writes out a TypeScript worker where each supported endpoint becomes a callable tool. It sits alongside Notion's own command line tool, called ntn, which handles authentication, building, deploying, and running workers. WorX does not replace ntn. Instead it focuses on one job: generating the worker code automatically so you do not have to write each endpoint mapping by hand. Using it is a two step process. First you point the CLI at your OpenAPI spec, either a local file or a URL, and tell it where to write the generated project. Then you move into that generated folder, install its dependencies, and deploy it using the generated deploy scripts. Options let you filter which endpoints get generated by tag, preview the output without writing files, or trigger a deploy automatically once generation finishes. The current version supports OpenAPI 3.0 and 3.1, REST APIs using JSON or form encoded request bodies, path, query, and header parameters, and both bearer token and API key authentication. It can resolve references within the same file and handles large sets of optional parameters through a generated helper object. It does not yet resolve references that point to other files, and OAuth2 or OpenID flows need to be wired up by hand. Endpoints that rely on file uploads, binary data, or XML only content are skipped, and complex schema combinations are simplified rather than fully modeled. A practical note for anyone trying this: Notion enforces a cap on how many tools a single worker can expose, currently 100, so a large API may need to be split into multiple generated workers using the tag filter option. The project is released under the MIT license and includes standard contribution, security, and code of conduct documentation.

Copy-paste prompts

Prompt 1
Help me run WorX against my OpenAPI spec file and explain what the generated worker project contains.
Prompt 2
Show me how to filter WorX generation to only include endpoints tagged 'users' from my OpenAPI spec.
Prompt 3
Walk me through deploying a WorX generated Notion Worker for the first time, including setting up .env secrets.
Prompt 4
My API has more than 100 endpoints, help me split it into multiple Notion Workers using WorX's --filter option.
Prompt 5
Explain the difference between what WorX does and what the ntn CLI does in a Notion Worker workflow.

Frequently asked questions

What is notion-workx?

A code generator that turns an OpenAPI spec into a deployable Notion Worker project, mapping each API endpoint to a callable tool automatically.

What language is notion-workx written in?

Mainly TypeScript. The stack also includes TypeScript, Node.js, OpenAPI.

What license does notion-workx use?

Use freely for any purpose, including commercial use, as long as you keep the copyright notice.

How hard is notion-workx to set up?

Setup difficulty is rated moderate, with roughly 30min to a first successful run.

Who is notion-workx for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.