syncable-entity-types-and-constants

Define TypeORM entities and register syncable entity constants in Twenty.

Updated Mar 5, 2026
One-click install
npx skills add https://github.com/kanojiyapratik/twentycrm --skill syncable-entity-types-and-constants-kanojiyapratik
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: syncable-entity-types-and-constants
Source: https://github.com/kanojiyapratik/twentycrm/tree/main/.cursor/skills/syncable-entity-types-and-constants
Command: npx skills add https://github.com/kanojiyapratik/twentycrm --skill syncable-entity-types-and-constants-kanojiyapratik

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured and standardized way to define new syncable entities within the Twenty CRM system, ensuring consistency and maintainability across the codebase. It addresses the complexity of managing entity types, relationships, and constants required for data synchronization and migration.

Core Features & Use Cases

  • Entity Definition: Establishes TypeORM entities, flat entity types, and action types for new syncable entities.
  • Constant Registration: Registers these new entities and their properties within central constants for system-wide recognition and use.
  • Relationship Management: Defines one-to-many and many-to-one relationships between entities, crucial for data integrity.
  • Use Case: When developing a new feature that requires a custom object (e.g., "Projects"), this Skill guides the developer through creating all necessary type definitions and constant registrations to integrate it seamlessly into the CRM's syncable entity framework.

Quick Start

Follow the step-by-step instructions in this Skill to add a new metadata name constant to ALL_METADATA_NAME.

Frequently Asked Questions about syncable-entity-types-and-constants

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new syncable entity to a Twenty CRM workspace?

To add a new syncable entity to a Twenty CRM workspace, you define TypeORM entities, flat entity types, and register the new metadata name constant in central constants like ALL_METADATA_NAME.

What are syncable entity types and when do I need them for CRM development?

Syncable entity types are structured TypeScript type definitions and TypeORM entities needed when creating custom objects in Twenty CRM to ensure data consistency and migration integrity across the workspace.

How do I configure one-to-many and many-to-one relationships for TypeORM entities?

You configure entity relationships by registering them in central constants such as ALL_ONE_TO_MANY_METADATA_RELATIONS and ALL_MANY_TO_ONE_METADATA_FOREIGN_KEY to maintain data integrity.

Does this CRM data modeling approach require registering constants in a central configuration?

Yes, this CRM data modeling approach requires registering new entities and their properties in central constants like ALL_ENTITY_PROPERTIES_CONFIGURATION_BY_METADATA_NAME for system-wide recognition.

What's the best way to define action types for new entities in a workspace migration system?

The best way to define action types for new entities is to establish them alongside TypeORM entities and flat entity types, then register the metadata in central constant configurations.