Trigger Types: Real-Time Events and Callback-Based Multi-Step Data Exchanges

Feature Overview

  • Znode 10 enhances the Commerce Connector with support for multi-step data exchanges, real-time eventing, and real-time callback execution. These enhancements enable organizations to orchestrate complex integration workflows, automate integrations based on business events, and retrieve live external data during storefront requests. 
  • Previously, Data Exchanges supported only a fixed two-step integration architecture (source → destination). This enhancement introduces a flexible multi-step pipeline architecture that supports sequential processing across APIs, SFTP, Blob Storage, and external systems.
    • The new HTTP-based Trigger Execution framework enables two real-time execution models:
      • Znode Event (Push Model) – Automatically triggers a Data Exchange when a configured event occurs within Znode.  
      • Znode Callback (Pull Model) – Retrieves live pricing or inventory data from external systems during storefront requests such as Product Detail Page (PDP) loads. 
  •  This enhancement enables real-time integrations while maintaining backward compatibility with existing scheduler-based Data Exchanges. 

Key Features

  • Multi-Step Data Exchanges
    • Data Exchanges now support unlimited sequential integration steps instead of the previous fixed two-step model. 
    • Supported Transmission Modes
      • API 
      • SFTP 
      • Blob Storage
    • Multi-Step Capabilities
      • Add unlimited integration steps 
      • Configure independent mappers for each step 
      • Sequential step execution
      • Reuse data from previous steps
      • Configure transformations per step
    • Step Data Referencing
      • Data from previous steps can be referenced using:
        • step1.fieldName
        • step2.fieldName
      • Example:
        • Step1.Account.Name
  • Trigger Execution Framework
    • A new Trigger Execution (HTTP) configuration section is available within the Manage Data Exchange screen.
    • Trigger Execution type must be set to on when using multi step data exchanges 
    • Supported Trigger Types
      • Znode Event (Push-Based Execution)
        • Automatically executes a Data Exchange when configured system events occur.
        • Supported event modules include: 
          • Account
          • Order
          • Product
          • Category
          • Price
          • Inventory
          • Catalog
          • Portal
        • Example use cases:
          • Account updates
          • Order creation
          • Product changes
    • Important Eventing Behavior
      • Event payloads contain minimal information such as:
        • eventDataCode
        • eventModule
        • eventName
    • Complete entity data must be retrieved in subsequent API steps using the provided payload values.
    • Example:
      • Payload.eventdatacode

         
  • Znode Callback (Pull-Based Execution)
    • Znode Callback enables storefront pages to retrieve real-time data from external systems during user activity.
    • Supported Callback Types
      • Real-Time Pricing
      • Real-Time Inventory  
      • Real-Time Order Details
      • Order Status
    • Callback Behavior
      • When a storefront request occurs
        • Znode triggers the callback
        • Commerce Connector calls the external API
        • Response data is transformed using the Global Mapper
        • Live data is returned to the storefront 
    • Supported Storefront Scenarios
      • Real-time pricing on PDP
      • Real-time inventory availability
      • Dynamic order information
  • Enhanced Manage Data Exchange Experience
    • The Manage Data Exchange screen now contains:
      • Exchange Details / Base Definition Details
      • Trigger Execution (HTTP)
      • Data Flow Configuration
    •  Integration Type Column
      • A new Integration Type column is added to the Data Exchange listing page. 
      • Supported values:
        • Two-Step – Legacy integration architecture
        • Multi-Step – Enhanced configurable integration flow
           
  • Step-Level Mapping Enhancements
    • Each step in a multi-step exchange now contains its own independent mapper
  • Behavior Changes 
    • Mappers are no longer shared globally
    • GET/API retrieval steps may not require mappings
    • Transformations are configured only where needed
  • Global Mapper
    • Callback-based exchanges introduce a Global Mapper used specifically to format responses returned to Znode. 
    • Example required mappings:
      •  Sales Price
      • Retail Price
      • SKU
      • Line Item ID
  • Backward Compatibility
    • Existing scheduler-based Data Exchanges continue functioning without modification.
    • Behavior
      • Legacy two-step exchanges remain supported (Edit mode only)
      • Existing integrations are unaffected
    • No migration is required
    • New real-time integrations use HTTP-trigger-based architecture
  • Workflow
    • Real-Time Eventing Workflow (Push Model)
      • A configured Znode Event occurs
      • Trigger validation executes
      • Data Exchange execution initializes
      • Sequential steps execute
      • Mapper transformations are applied
      • API/SFTP/Blob operations execute
      • Execution logs are generated
      • Status is marked Completed or Failed
    • Example Event Workflow
      • Account Updated → Fetch Account Details → Transform Data → Send to ERP/SFTP
  • Real-Time Callback Workflow (Pull Model)
    • Shopper opens PDP
    • Znode triggers callback request
    • Commerce Connector calls external API
    • API response is transformed using Global Mapper
    • Live pricing/inventory is returned to Znode
    • PDP displays real-time data
    • Execution logs are generated 
    • Example Callback Workflow
      • PDP Load → External Pricing API → Response Mapping → Live Price Display  
  • Multi-Step Execution Workflow
    • Step 1 retrieves data
    • Step output is stored
    • Step 2 consumes previous output
    • Mapper transformations execute
    • Additional sequential steps process data
    • Final execution result is returned 
  • Important Notes and Limitations
    • Important Conditions
      • Callback Data Exchanges must be enabled
      • Legacy real-time pricing/inventory integrations must be disabled for callback execution
      • Disabling callback exchanges reverts storefront pricing/inventory to stored Znode values  
  • Current Limitations
    • The following capabilities are currently not supported:
      • Advanced retry monitoring UI
      • Pagination and aggregation in multi-step flows
      • Copying multi-step exchanges
      • Custom processors in multi-step flows
      • Step output persistence
      • Advanced monitoring dashboards
  • Prerequisites
    • Before configuring Real-Time Eventing or Callback:
      • Administrator access to the Znode Admin Console
      • Commerce Connector must be enabled
      • External APIs or endpoints must be reachable
      • ERP/SFTP/Blob configurations must be available
      • Legacy RP integrations must be disabled for callback scenarios
  • Scheduler & Exchange Recommendations
    • Supported Scheduler Types
      Scheduler TypePurpose
      ScheduledAutomated recurring exchanges
      OnDemandManual execution
      RealTimeEvent-triggered immediate processing
  • Recommended Production CRON Frequencies
    Exchange TypeRecommended Frequency
    Inventory SyncEvery 15 minutes
    Order ExportEvery 15–30 minutes
    Price SyncEvery 4 hours
    Product ImporDaily
    Full Catalog SyncWeekly
  • Important Scheduler Guidelines
    •  Do not configure scheduler intervals below 5 minutes. 
    • High-frequency jobs may overload Hangfire queues.
    • Large exchanges should be scheduled during off-peak hours.  
    • Long-running jobs should use dedicated queues where possible.
  • Pagination & Data Volume Recommendations
    • Recommended Page Sizes
      Data TypeRecommended Page Size Maximum Recommended
      Inventory5005,000
      Orders2003,000
      Products2503,000
      Prices1,0005,000
      Customers2503,000
  • Pagination Guidelines
    • Pagination should always be enabled for API-based exchanges.
    • Page sizes above 1,000 may cause memory pressure.
    • Very small page sizes increase HTTP overhead. 
    • Large payloads increase serialization and deserialization costs.
  • Recommended Processing Limits
    ParameterRecommended Maximum
    Export records per file5,000
    Export file size50 MB
    API payload size10 MB
    Concurrent export jobs3 per server
  • Real-Time Processing Guidelines
    • Real-Time Processing Characteristics
      • Real-time exchanges execute as synchronous HTTP operations. 
      • The request lifecycle includes:
        • Request received
        • Processor execution
        • ERP/Znode API communication
        • Data transformation
        • Immediate response returned 
    • Recommended Usage Patterns
      Recommended UsageNot Recommended
      Single order processingBulk catalog synchronization
      Single SKU inventory lookupLarge inventory exports
      Order acknowledgmentFull price synchronization
      Lightweight API workflowsLarge batch operations
  • Recommended Performance Targets
    MetricRecommended
    Response Time< 2 seconds
    Payload Size< 1 MB
    Concurrent Requests< 20
    ERP API Latency< 500 ms
  • Real-Time Operational Risks
    • Real-time exchanges are blocking operations.
    • Slow ERP APIs directly impact storefront performance.
    • No queue buffering exists for real-time requests. 
    • High concurrency may saturate API thread pools.
  • Inventory Synchronization Recommendations
    • Recommended Inventory Modes
      ScenarioRecommended Mode
      Product page inventory checkReal-Time
      Warehouse inventory syncScheduled
      Full inventory reconciliationFile-based
  • Inventory Synchronization Risks
    • Real-time inventory calls execute in line with storefront requests. 
    • Slow ERP APIs increase storefront latency.
    • No native in-process inventory caching exists. 
    • High inventory traffic can overload ERP systems. 
  • Recommended Mitigation Strategies
    • Enable Redis caching for inventory lookups. 
    • Use short cache expiration windows (2–5 minutes). 
    • Prefer scheduled synchronization for large catalogs. 
    • Avoid bulk real-time inventory requests.
    • Transmission Modes & File Processing
    • Supported Transmission Modes
      ModeRecommended Usage
      APIReal-time and lightweight integrations
      SFTPLegacy ERP file integrations
      Blob StorageLarge file exchange
      Import HandlerBulk Znode imports
  • Recommended File Processing Limits
    Import TypeRecommended Batch Size
    Product Import1,000–10,000
    Price Import2,500–10,000
    Inventory Import2,500–10,000
    Category Import500–1,000
    Promotions500
  • File Processing Recommendations
    • Split large files into smaller batches. 
    • Avoid processing files larger than 50 MB. 
    • Prefer Blob Storage or SFTP for high-volume integrations. 
    • Increase timeout values for large imports where necessary. 
  • Infrastructure Sizing Recommendations
    • Recommended Production Sizing 
      EnvironmentCPUMemoryRecommended Instances
      Small1 vCPU2 GB1
      Mid-Market2 vCPU4 GB2
      Enterprise3+ vCP8–16 GB3+
  • Known Limitations & Constraints
    • Architecture Limitations
      IDLimitationImpact
      L1No hard-coded max record limit per exchangeLarge exchanges may cause memory pressure
      L2Real-time processing is synchronousCaller blocks until processing completes
      L3Event queues may be temporaryEvents may be lost during a restart
      L4No built-in DLQFailed events may be discarded
      L5Shared Hangfire queueLong-running jobs may block short jobs
      L6Pagination retry counts are partially hardcodedLimited runtime tuning
      L7SQL parser timeout constraintsLarge parsing jobs may fail
      L8No built-in real-time rate limitingERP APIs may be overloaded
      L9SFTP reconnect per fileSlow for many small files
      L10Real-time calls execute inlineNo buffering or async queueing
  • Operational Constraints
    ConstraintDetails
    Minimum Scheduler Interval5 minutes recommended
    Real-Time Payload Size10 MB maximum recommended
    Export File Size50 MB recommended maximum
    API Page Size5,000 recommended maximum 
    Concurrent Real-Time RequestsMore than 20 may impact stability
  • Recommended Data Volume Limits
    Exchange TypeRecommended Limit
    Product Import10,000 rows per batch
    Price Import10,000 rows per batch
    Inventory Import 10,000 rows per batch
    Category Import2,000 rows per batch
  • Unsupported Configurations & Anti-Patterns
    The following patterns are not recommended and may negatively impact performance or system stability.
    Anti-PatternRisk
    Real-time full catalog synchronizationAPI thread exhaustion
    Real-time bulk inventory updatesERP overload
    Page sizes greater than 5,000Memory spikes
    CRON execution every 30 secondsHangfire saturation
    Single-node RabbitMQ deploymentsSingle point of failure
    Very large XML payloadsHigh memory allocation
    Running all workloads on a single queueQueue starvation
    Large synchronous ERP callsStorefront slowness

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.