Конфигурация приложения

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

• Идентификация — универсальный идентификатор, отображаемое имя, описание.
• Разрешения — от имени какой роли выполняются его логические функции и фронтенд-компоненты.
• Переменные (необязательно) — пары ключ–значение, доступные вашему коду как переменные окружения.
• Хуки предустановки / постустановки (необязательно) — см. Логические функции.

import { defineApplication } from 'twenty-sdk/define';
import { DEFAULT_ROLE_UNIVERSAL_IDENTIFIER } from 'src/roles/default-role';

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,
    },
  },
  defaultRoleUniversalIdentifier: DEFAULT_ROLE_UNIVERSAL_IDENTIFIER,
});

• Поля universalIdentifier — это детерминированные идентификаторы, которые принадлежат вам. Сгенерируйте их один раз и сохраняйте неизменными между синхронизациями.
• applicationVariables становятся переменными окружения для ваших функций и фронтенд-компонентов (например, DEFAULT_RECIPIENT_NAME доступна как process.env.DEFAULT_RECIPIENT_NAME).
• defaultRoleUniversalIdentifier должен ссылаться на роль, определённую с помощью defineRole().
• Предустановочные и постустановочные функции обнаруживаются автоматически во время сборки манифеста — вам не нужно указывать их в defineApplication().

​

Роль функции по умолчанию

• Токен времени выполнения, подставляемый как TWENTY_APP_ACCESS_TOKEN, формируется из этой роли.
• Типизированный клиент API ограничен правами, предоставленными этой роли.
• Следуйте принципу наименьших привилегий: объявляйте только те разрешения, которые действительно нужны вашим функциям.

​

Метаданные маркетплейса