Skip to main content

​
Reserved Namespaces

​
Integration Namespaces

When working with integrations in CONA, use the appropriate namespace prefix for consistency and clarity.
IntegrationNamespace PrefixExample Usage
CONAcona_cona_invoice_id, cona_customer_tags
Shopifyshopify_shopify_order_id, shopify_customer_tags
PayPalpaypal_paypal_transaction_id, paypal_payer_email
Amazonamazon_amazon_order_id, amazon_customer_tags
DATEVdatev_datev_invoice_id, datev_customer_tags
Ebayebay_ebay_order_id, ebay_customer_tags
SAPsap_sap_invoice_id, sap_customer_tags
Quickbooksqb_qb_invoice_id, qb_customer_tags
Stripestripe_stripe_customer_id, stripe_payment_intent
Xeroxero_xero_contact_id, xero_invoice_number
Squaresquare_square_payment_id, square_location_id
Navisionnavision_navision_invoice_id, navision_customer_tags
NetSuitenetsuite_netsuite_invoice_id, netsuite_customer_tags
Sagesage_sage_invoice_id, sage_customer_tags
Zohozoho_zoho_invoice_id, zoho_customer_tags
BigCommercebigcommerce_bigcommerce_order_id, bigcommerce_customer_tags
Magentomagento_magento_order_id, magento_customer_tags
WooCommercewoo_woo_order_id, woo_customer_tags
PrestaShoppresta_presta_order_id, presta_customer_tags
OpenCartopencart_opencart_order_id, opencart_customer_id
Shopwareshopware_shopware_order_id, shopware_customer_number
Klarnaklarna_klarna_order_id, klarna_payment_reference
PayPalPluspaypalplus_paypalplus_transaction_id, paypalplus_status
Adyenadyen_adyen_payment_id, adyen_merchant_reference
Molliemollie_mollie_payment_id, mollie_customer_id
Worldpayworldpay_worldpay_order_id, worldpay_transaction_id
Braintreebraintree_braintree_transaction_id, braintree_customer_id
SumUpsumup_sumup_transaction_id, sumup_payment_type
iZettleizettle_izettle_order_id, izettle_payment_reference
Authorize.netauthnet_authnet_transaction_id, authnet_customer_id
2Checkout2checkout_2checkout_sale_id, 2checkout_payment_method
Afterpayafterpay_afterpay_order_id, afterpay_token
Sofortsofort_sofort_transaction_id, sofort_status
Giropaygiropay_giropay_transaction_id, giropay_result
iDEALideal_ideal_transaction_id, ideal_issuer
SEPAsepa_sepa_mandate_id, sepa_creditor_id
Bancontactbancontact_bancontact_payment_id, bancontact_status
Alipayalipay_alipay_trade_no, alipay_buyer_id
WeChat Paywechat_wechat_transaction_id, wechat_openid

​
Tool Slugs

ToolSlug
AR Reconar-recon
DATEV Exportdatev-export

​
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

// Database field names
const customer = {
  id: "cust_001",
  shopify_customer_id: "123456789",
  stripe_customer_id: "cus_ABC123DEF456",
  paypal_payer_email: "customer@example.com",
};

// Configuration keys
const integrationSettings = {
  shopify_webhook_secret: "whsec_...",
  stripe_publishable_key: "pk_...",
  paypal_client_id: "client_...",
};

// Event names
const events = ["shopify_order_created", "stripe_payment_succeeded", "paypal_payment_completed"];

​
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
⌘I