Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Deprecation – journeyEvents Fields in WebDeploymentConfigurationVersion

  • 1.  Deprecation – journeyEvents Fields in WebDeploymentConfigurationVersion

    Posted 07-22-2025 12:28
    Edited by Ananya Singh 07-22-2025 12:32

    Summary

    We are announcing the deprecation of the following three fields within WebDeploymentConfigurationVersion.journeyEvents:

    • excludedQueryParameters
    • shouldKeepURLFragments
    • searchQueryParameters

    These fields were originally introduced during an initiative to migrate web tracking settings from Genesys Predictive Engagement to Web Messaging Deployment configurations. However, the migration was never completed, and these fields remain inactive and unused by any features. Their presence may cause confusion, as they currently have no functional impact.

    For guidance on configuring web tracking, please refer to the Genesys Cloud Resource Center: Web tracking – Genesys Cloud Resource Center

    Effective Date

    Tuesday, July 22, 2025

    Details

    The deprecation of the inactive JourneyEvents fields — excludedQueryParameters, shouldKeepURLFragments, and searchQueryParameters within WebDeploymentConfigurationVersion — facilitates the introduction of new, technically optimized fields better suited for web tracking settings. This transition supports the provisioning and configuration of Journey Tracking directly through a unified digital apps framework that includes Messaging, Journey Tracking, Knowledge, Co-browse, and more features to come.

    Customer Impact

    The following API is affected:

    Web Deployment API

    Specifically, the POST /api/v2/webdeployments/configurations endpoint will no longer support the use of:

    • excludedQueryParameters
    • shouldKeepURLFragments
    • searchQueryParameters under journeyEvents

    Please note: While the fields will still exist in the schema, their use is discouraged and they should be considered deprecated.*

    Impacted Resources

    POST /api/v2/webdeployments/configurations

    Issue References

    [AI-1102]

    [CPR-940]

    Contacts

    @Mai-Christine Hoang  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.