Configuración de la aplicación

• Identidad — identificador universal, nombre para mostrar, descripción.
• Permisos — bajo qué rol se ejecutan sus funciones de lógica y componentes de frontend.
• Variables (opcionales) — pares clave–valor expuestos a tu código como variables de entorno.
• Hooks de preinstalación / posinstalación / desinstalación (opcionales) — consulta Funciones de lógica.

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

• Los campos universalIdentifier son identificadores deterministas que te pertenecen. Genéralos una vez y mantenlos estables entre sincronizaciones.
• applicationVariables se convierten en variables de entorno para tus funciones y componentes de frontend. En las funciones lógicas (del lado del servidor), están disponibles como process.env.VARIABLE_NAME. En los componentes de frontend, usa getApplicationVariable('VARIABLE_NAME') de twenty-sdk/front-component. Las variables marcadas con isSecret: true solo se inyectan en las funciones lógicas. Los componentes de frontend solo reciben variables no secretas.
• El rol predeterminado se detecta automáticamente a partir del archivo de rol marcado con defineApplicationRole(); no necesitas hacer referencia a él desde defineApplication().
• Las funciones de preinstalación, posinstalación y desinstalación se detectan automáticamente durante la compilación del manifiesto; no necesitas referenciarlas en defineApplication().
• Pasar defaultRoleUniversalIdentifier explícitamente sigue siendo compatible por motivos de retrocompatibilidad, pero está en desuso en favor de defineApplicationRole().
• serverVariables son configuraciones y secretos con ámbito de instancia (por ejemplo, claves de API). A diferencia de applicationVariables, no declaran ningún valor en el manifiesto: el operador del espacio de trabajo los completa desde la configuración de la aplicación, y se inyectan en las funciones lógicas solo una vez que se han establecido.
• Ambos tipos de variable aceptan isDeprecated: true. Úsala para retirar una variable en lugar de eliminarla: mantener la clave declarada conserva el valor almacenado (eliminarla destruye el valor que el operador introdujo), y la variable sigue siendo inyectada, por lo que tu código puede recurrir a ella — process.env.NEW_API_KEY ?? process.env.API_KEY. Una variable obsoleta desaparece de la configuración de la app una vez que no tiene ningún valor y nunca cuenta para la verificación de configuración de la app, por lo que isDeprecated tiene prioridad sobre isRequired.
• Para mostrar una interfaz de configuración personalizada dentro de la pestaña Settings de la aplicación (en lugar de la sección predeterminada de configuración de variables), declara un componente de frontend con defineSettingsFrontComponent() en su propio archivo. Solo se permite uno por aplicación. Las secciones gestionadas por el sistema (actualización automática, App URL, conexiones) siempre permanecen visibles.

​

Tipos de variables

import { defineApplication, FieldType } from 'twenty-sdk/define';

export default defineApplication({
  // ...identity, role...
  applicationVariables: {
    MAX_POSTCARDS: {
      universalIdentifier: '5f4497e4-9030-4085-85eb-2c48b8d53713',
      description: 'Maximum postcards per batch',
      type: FieldType.NUMBER,
      value: 10,
    },
    DEFAULT_REGION: {
      universalIdentifier: '76c5c321-b6b6-46eb-b4fc-f9f04bb04227',
      description: 'Default shipping region',
      type: FieldType.SELECT,
      options: [
        { label: 'Europe', value: 'eu' },
        { label: 'United States', value: 'us' },
      ],
      value: 'eu',
    },
  },
});

const maxCards = Number(process.env.MAX_POSTCARDS); // "10" -> 10
const enabled = process.env.ENABLE_TRACKING === 'true'; // "true" -> true
const channels = JSON.parse(process.env.ENABLED_CHANNELS ?? '[]'); // '["email"]' -> ["email"]
const config = JSON.parse(process.env.PROVIDER_CONFIG ?? '{}'); // '{"retries":3}' -> { retries: 3 }

​

Rol de función predeterminado

• Los tokens en tiempo de ejecución inyectados en tus funciones de lógica se derivan de este rol. Una llamada que actúa como una persona se limita aún más a lo que esa persona puede hacer, por lo que nunca puede superar ninguno de los dos. Consulta Qué acceso usa una llamada.
• El cliente de API tipado está restringido a los permisos otorgados a ese rol.
• Sigue el principio de mínimo privilegio: declara solo los permisos que necesitan tus funciones.

​

Metadatos del Marketplace