Syndeo Scripting API

Welcome to the Syndeo Scripting API. This documentation provides Syndeo Script developers with the necessary information to build powerful and flexible scripts within the Syndeo platform.

The primary entry point for all scripting capabilities is the cx.syndeo.script.api.SyndeoScriptAPI interface. From there, you can access functionalities for managing variables, making HTTP calls, interacting with the cache, and more.

The Syndeo Script API and associated objects are exposed to Syndeo Developers via Javascript (compliant to ECMAScript 2024) and Groovy (v3). The API is exposed from the syndeo object in Scripts.

JavaScript Example

    
        // Get a handle on the variables object
        var variables = syndeo.getVariables();

        // Set a new variable named 'greeting'
        variables.set('Greeting', 'Hello, World!');

        // Log a message to the script execution logs
        syndeo.log("The script has run successfully.");

Groovy Example


        // Get a handle on the variables object
        def variables = syndeo.getVariables()

        // Set a new variable named 'greeting'
        variables.set('Greeting', 'Hello, World!')

        // Log a message to the script execution logs
        syndeo.log("The script has run successfully.")

Please explore the packages and classes listed below to understand the full capabilities of the API.