Naming Conventions¶

Entity Names¶

Convention	Example	Use
PascalCase	`ServiceRequest`	Entity name
camelCase	`serviceRequest`	Link field name
snake_case	`service_request`	Table name

Field Names¶

Type	Convention	Example
Link	`{entity}Id`	`accountId`, `assignedUserId`
LinkMultiple	`{entity}Ids`	`teamIds`
Foreign	`{link}{Field}`	`accountName`, `assignedUserName`

Workflow Names¶

Format: {Entity}{Action}{Trigger}
Example: ServiceRequestAssignmentAfterSave

Examples¶

# Correct
entities:
  ServiceRequest:        # PascalCase
    table: "service_request"  # snake_case
    fields:
      accountId: ...     # camelCase with Id suffix
      assignedUserId: ...

# Incorrect
entities:
  service_request:       # snake_case for entity
    table: "ServiceRequest"  # PascalCase for table
    fields:
      account_id: ...    # snake_case for field

For a full specification example see Integrations for real-world cases.