메인 콘텐츠로 건너뛰기
모든 앱에는 defineApplication 호출이 정확히 하나 있어야 합니다. 다음 항목을 선언합니다:
  • 식별 정보 — 범용 식별자, 표시 이름, 설명.
  • 권한 — 로직 함수와 프런트 컴포넌트가 어떤 역할로 실행되는지.
  • 변수 (선택 사항) — 코드에 환경 변수로 노출되는 키–값 쌍.
  • 설치 전/후 훅 (선택 사항)Logic Functions를 참조하세요.
src/application-config.ts
import { defineApplication } from 'twenty-sdk/define';

export default defineApplication({
  universalIdentifier: '39783023-bcac-41e3-b0d2-ff1944d8465d',
  displayName: 'My Twenty App',
  description: 'My first Twenty app',
  applicationVariables: {
    DEFAULT_RECIPIENT_NAME: {
      universalIdentifier: '19e94e59-d4fe-4251-8981-b96d0a9f74de',
      description: 'Default recipient name for postcards',
      value: 'Jane Doe',
      isSecret: false,
    },
  },
});
노트:
  • universalIdentifier 필드는 여러분이 소유하는 변하지 않는 고유 ID입니다. 한 번만 생성하고 이후 동기화 동안에도 변하지 않도록 유지하세요.
  • applicationVariables는 함수와 프런트 컴포넌트의 환경 변수가 됩니다. 로직 함수(서버 사이드)에서는 process.env.VARIABLE_NAME으로 사용할 수 있습니다. 프런트 컴포넌트에서는 twenty-sdk/front-componentgetApplicationVariable('VARIABLE_NAME')을 사용하세요. isSecret: true로 표시된 변수는 로직 함수에만 주입됩니다. 프런트 컴포넌트는 비밀이 아닌 변수만 받습니다.
  • 기본 역할은 defineApplicationRole()로 표시된 역할 파일에서 자동으로 감지되므로, defineApplication()에서 이를 참조할 필요가 없습니다.
  • 설치 전/후 함수는 매니페스트 빌드 중 자동으로 감지됩니다 — defineApplication()에서 별도로 참조할 필요가 없습니다.
  • 하위 호환성을 위해 defaultRoleUniversalIdentifier를 명시적으로 전달하는 방식도 계속 지원되지만, 이제는 defineApplicationRole() 사용을 권장하며 이전 방식은 더 이상 권장되지 않습니다.

기본 함수 역할

defineApplicationRole()로 선언된 역할은 앱의 로직 함수와 프런트엔드 컴포넌트가 무엇에 접근할 수 있는지를 제어합니다:
  • TWENTY_APP_ACCESS_TOKEN로 주입되는 런타임 토큰은 이 역할에서 파생됩니다.
  • 타입드 API 클라이언트는 해당 역할에 부여된 권한으로 제한됩니다.
  • 최소 권한 원칙을 따르세요: 함수에 필요한 권한만 선언하세요.
새 앱을 스캐폴딩하면 CLI가 src/roles/default-role.ts에 시작용 역할 파일을 생성합니다. 전체 내용은 Roles & Permissions를 참조하세요.

마켓플레이스 메타데이터

앱을 게시할 계획이라면, 다음 선택적 필드로 마켓플레이스에서 표시되는 방식을 제어합니다:
필드설명
author작성자 또는 회사 이름
category마켓플레이스 필터링을 위한 앱 카테고리
logoUrl앱 로고의 경로(예: public/logo.png)
screenshots스크린샷 경로의 배열(예: public/screenshot-1.png)
aboutDescription”About” 탭에 대한 더 긴 마크다운 설명. 생략하면 마켓플레이스는 npm의 패키지 README.md를 사용합니다
websiteUrl웹사이트 링크
termsUrl서비스 약관 링크
emailSupport지원 이메일 주소
issueReportUrl이슈 트래커 링크