martmull
e289f3056e
- moves applicationRoleId to application entity - add new `APPLICATION` FieldActorSource and `APPLICATION` JwtTokenTypeEnum value - create a new token with applicationId when executing a function - when applicationId is in token, check for application.defaultRole permissions -use twenty-shared types in `twenty-sdk/application` - create a new import from generate called "Twenty" that you can use directly without having to set TWENTY_API_KEY AND TWENTY_API_URL (keep metadata or core parameter only) - provide to serverless unique one time BEARER TOKEN to run it Result <img width="977" height="566" alt="image" src="https://github.com/user-attachments/assets/e78428a0-5b13-4975-aa13-58ee3b32450c" /> <img width="910" height="596" alt="image" src="https://github.com/user-attachments/assets/6ec72bf5-7655-4093-a45e-ad269595a324" /> <img width="741" height="568" alt="image" src="https://github.com/user-attachments/assets/7683944c-fd79-4417-8fb2-8e4815cc112f" />
Twenty SDK
A CLI and SDK to develop, build, and publish applications that extend Twenty CRM.
- Type‑safe client and workspace entity typings
- Built‑in CLI for auth, generate, dev sync, one‑off sync, and uninstall
- Works great with the scaffolder: create-twenty-app
Prerequisites
- Node.js 24+ (recommended) and Yarn 4
- A Twenty workspace and an API key. Generate one at https://app.twenty.com/settings/api-webhooks
Installation
npm install twenty-sdk
# or
yarn add twenty-sdk
Getting started
You can either scaffold a new app or add the SDK to an existing one.
- Start new (recommended):
npx create-twenty-app@latest my-twenty-app cd my-twenty-app - Existing project: install the SDK as shown above, then use the CLI below.
CLI quickstart
# Authenticate using your API key (CLI will prompt for it)
twenty auth login
# Add a new entity to your application (guided prompts)
twenty app add
# Generate a typed Twenty client and TypeScript definitions for your workspace entities
twenty app generate
# Start dev mode: automatically syncs changes to your workspace for instant testing
twenty app dev
# One‑time sync of local changes
twenty app sync
# Uninstall the application from the current workspace
twenty app uninstall
Usage (SDK)
// Example: import what you need from the SDK
import { /* your exports */ } from 'twenty-sdk';
Publish your application
Applications are currently stored in twenty/packages/twenty-apps.
You can share your application with all Twenty users:
# pull the Twenty project
git clone https://github.com/twentyhq/twenty.git
cd twenty
# create a new branch
git checkout -b feature/my-awesome-app
- Copy your app folder into
twenty/packages/twenty-apps. - Commit your changes and open a pull request on https://github.com/twentyhq/twenty
git commit -m "Add new application"
git push
Our team reviews contributions for quality, security, and reusability.
Troubleshooting
- Auth errors: run
twenty auth loginagain and ensure the API key has the required permissions. - Typings out of date: run
twenty app generateto refresh the client and types. - Not seeing changes in dev: make sure dev mode is running (
twenty app dev).