Skip to main content

Reserved Namespaces

Integration Namespaces

When working with integrations in CONA, use the appropriate namespace prefix for consistency and clarity.

Tool Slugs

Usage Guidelines

When to Use Namespaces

  1. Database Field Names: Always prefix custom fields with the appropriate integration namespace
  2. API Parameters: Use namespaced keys when passing integration-specific data
  3. Configuration Keys: Apply namespaces to settings and configuration values
  4. Event Names: Prefix events with their source integration namespace

Best Practices

  • Consistency: Always use the exact namespace prefix as defined in the table
  • Lowercase: Keep all namespace prefixes in lowercase
  • Underscore Separation: Use underscores to separate the namespace from the field name
  • Descriptive Names: Combine namespace with clear, descriptive field names

Examples

Adding New Namespaces

When adding support for a new integration:
  1. Research: Check if the integration already has a commonly used namespace convention
  2. Consistency: Choose a namespace that follows the existing pattern (lowercase, descriptive)
  3. Documentation: Update this table with the new namespace
  4. Team Review: Have the team review the proposed namespace before implementation

Reserved Prefixes

The following prefixes are reserved for CONA internal use:
  • cona_ - Core CONA system fields and identifiers
  • temp_ - Temporary fields that may be cleaned up
  • system_ - System-generated fields and metadata
  • audit_ - Audit trail and versioning fields