Getting Started for Integration Developers
Integration developers automate Digital.ai Release from outside the UI. They call the REST API, manage Release configuration as code with the XL CLI, script automation inside release pipelines, and connect Release to AI agents via the MCP Server. This guide covers the development approaches available in Release SaaS, the API references, and where to start for each.
Release SaaS is hosted and managed by Digital.ai. Customers cannot upload or manage custom plugins, but you can contact Digital.ai to request availability of a plugin that is not included in the managed catalog. The Go plugin SDK and JVM (Jython) plugin SDK are not available in SaaS. For external automation, use the REST API, Python 3 API Client, or the XL CLI. For in-pipeline automation, use a container-based script task. See Release SaaS Limitations.
Who This Guide Is For
This guide is for users who:
- Call the Release REST API from external systems or scripts.
- Automate Release configuration using the XL CLI and DevOps as Code (YAML).
- Run automation inside a release pipeline using webhook or container script tasks.
- Integrate Release with AI agents using the Release MCP Server.
For configuring existing integrations and setting up automated tasks in pipelines, see Getting Started for DevOps and Pipeline Engineers.
Choose Your Development Path
Start with the goal that matches what you need to build.
| Goal | Recommended Approach | Runtime | Start Here |
|---|---|---|---|
| Control Release from another system or script | REST API | External HTTP client | REST API Reference |
| Call Release from Python | Python API Client | External Python 3 process | Python API Client |
| Call an HTTP or SOAP endpoint from a pipeline | Webhook task | Release task runtime | Create a Webhook Task |
| Run Python 3 automation inside a pipeline | Python 3 Script (Container) task | Container through Release Runner | Python 3 Script Task |
| Manage Release configuration as code | DevOps as Code | XL CLI | Get Started with DevOps as Code |
| Connect Release to AI agents | MCP Server | Built into Release | Release MCP Server Overview |
Choosing an Approach
You do not need code for every integration. Start with the simplest option that fits the job.
| Need | Use |
|---|---|
| Call an HTTP or SOAP endpoint from a pipeline | Webhook Task |
| Run Python 3 automation in a container | Python 3 Script Task |
| Control Release from another system or script | REST API |
| Manage templates, folders, connections, variables, and releases as code | DevOps as Code |
| Connect Release to MCP-compatible AI agents | Release MCP Server |
Server-side scripting task types, such as Jython Script, Groovy Script, and Remote Script, are disabled in Release SaaS for security reasons. Use the Python 3 Script (Container) task as the isolated, container-based alternative. To move existing scripts across, see Migrate from Jython to Python 3.
Authentication
Requests to the REST API and commands issued by the XL CLI authenticate as a Release user. Use a personal access token rather than a password for automation and service accounts. See Personal Access Token for Authentication.
The permissions available to your integration are those of the user or token it authenticates as, which in Release SaaS derive from the user's Digital.ai Platform group. See User Group Permissions.
API Reference Documentation
The following API references are available for Release SaaS:
| Reference | URL |
|---|---|
| REST API Reference | REST API Docs |
| Python API Reference | Python API Client Docs |
The Jython API and DSL API are not available in Release SaaS.
For an overview of the developer resources available, see Release SaaS Developer Docs.
Release Automation
Release provides several ways to automate tasks and interact with third-party systems from within a release pipeline.
REST API
The REST API is the primary way to control Release from external systems. It exposes core Release functionality over HTTP, with data exchanged in JSON format. Use it to start releases, complete tasks, add comments, query release status, and more.
Python API Client
The Release Python API Client is a standalone Python 3 library for the REST API. It is the Python 3 equivalent of the Jython API, using the same domain classes and method names, which makes it the migration target for existing Jython automation. See Python API Client.
Webhook Tasks
Use a Webhook Task to call any HTTP endpoint (REST or SOAP) from within a release pipeline. Parse the response into a Release variable for use in subsequent tasks. No scripting required.
Python 3 Script Tasks
Use a Python 3 Script (Container) task to run a Python 3 script in a container through Release Runner, with direct access to the Release API and current-context helpers. This is the supported way to run custom script logic in Release SaaS. See Migrate from Jython to Python 3.
For a full overview of all automation options, see API and Scripting Overview.
DevOps as Code
DevOps as Code lets you define Release configuration, such as templates, folders, connections, variables, and releases, as YAML files and apply them using the XL CLI. This enables version-controlled, code-reviewed, and repeatable management of Release configuration.
XL CLI
The XL CLI (xl) is the command-line interface for DevOps as Code operations.
YAML Format
Release configuration is expressed in a YAML format understood by the XL CLI.
Blueprints
Blueprints are parameterized YAML templates that generate Release configuration from a set of inputs. Use them to scaffold standard release pipeline configurations on demand.
Release MCP Server
Digital.ai Release includes a built-in Model Context Protocol (MCP) server, bundled by default through the Release MCP Tools Plugin. It powers AI Assistant and lets any MCP-compatible client, such as Claude Code, Cursor, Claude Desktop, Visual Studio Code, or GitHub Copilot, interact with releases, templates, tasks, and variables using natural language.
No separate installation is required. The MCP server is enabled by default, and an administrator can enable or disable it in System Settings > AI Settings. To connect an external AI agent, generate a personal access token and use the connection snippet on the MCP Server settings page.
Key Capabilities
- Release Management: Create, search, count, and manage releases.
- Template Operations: Design, review, and optimize release templates with AI guidance.
- Task and Phase Management: Add, update, convert, and delete tasks or phases.
- Configuration Management: Integrate with external systems, such as Jenkins, Jira, and Git, and manage configuration objects.
- Variable Management: Manage variables across global, folder, release, and template scopes.
- Monitoring and Analysis: Retrieve activity logs, analyze failures, and get AI-powered root cause suggestions.
- Read-only Mode: Explore and analyze the Release environment without making changes.