---
title: "Groovy API reference"
slug: "groovy-api-reference"
description: "Use the downloadable Groovy API reference to find information about custom classes, methods, and APIs available for Groovy scripts in Zilliant CPQ and Agreements."
updated: 2026-10-08T07:15:07Z
published: 2026-10-08T07:15:07Z
canonical: "docs.zilliant.com/groovy-api-reference"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zilliant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Groovy API reference

Use the [downloadable Groovy API reference](/main/docs/groovy-api-reference#download-the-groovy-api-reference) to find information about custom classes, methods, and APIs available for Groovy scripts in [Zilliant CPQ](/main/docs/about-cpq) and [Agreements](/main/docs/agreements).

Zilliant supports [Apache Groovy](https://groovy-lang.org/) scripts to extend standard application behavior. In Zilliant CPQ and Agreements, Groovy scripts can run automatically when users perform supported actions, such as creating a quote, creating or updating an agreement, submitting a document for approval, publishing an accepted agreement, or updating specific field values.

## What the reference includes

The downloadable Groovy API reference includes technical reference information about custom Groovy classes and APIs available in Zilliant CPQ and Agreements.

Use the reference when you need to:

- Check available classes and methods
- Review method signatures and expected parameters
- Understand which objects are available to custom scripts
- Build or maintain scripts for supported Groovy extension points

## Download the Groovy API reference

The Groovy API reference is provided as a downloadable Javadoc-style HTML reference:

| Downloadable Groovy API reference | Version |
| --- | --- |
| [](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/GroovyApiReference(2).zip?sv=2026-02-06&spr=https&st=2026-11-10T06%3A38%3A42Z&se=2026-11-10T07%3A38%3A42Z&sr=c&sp=r&sig=YoJvrfIJ44wHH3wLI9XG%2F%2FI%2BGrDkKgbfnnlL7hVSYUo%3D)GroovyApiReference815.73 KB[](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/GroovyApiReference(2).zip?sv=2026-02-06&spr=https&st=2026-11-10T06%3A38%3A42Z&se=2026-11-10T07%3A38%3A42Z&sr=c&sp=r&sig=YoJvrfIJ44wHH3wLI9XG%2F%2FI%2BGrDkKgbfnnlL7hVSYUo%3D) | 2608 |

To view the reference:

1. Download the Groovy API reference archive.
2. Extract the archive to a local folder.
3. Open **index.html** in a web browser to view the reference homepage. From there, browse packages, classes, methods, and other API details.

You can open other HTML files in the extracted folder directly if you know which package, class, or method you need.

> [!WARNING]
> Note
> 
> The extracted archive contains multiple HTML files and supporting assets. Keep the extracted folder structure unchanged. Moving or deleting files from the extracted folder may break navigation, search, or links between reference pages.

## Review Groovy script documentation

Before you create or update a Groovy script, review the product documentation for Groovy scripts and custom logic in Zilliant CPQ and Agreements. The documentation explains how to upload script files, how scripts support product-specific extension points, when each script runs, which binding variables are available, what output the script must return, and which configuration steps are required.

To learn more, read the following topics:

- [About Groovy](/main/docs/about-groovy)
- [Binding variables](/main/docs/binding-variables)
- [Upload a Groovy script](/main/docs/upload-a-groovy-script)
- [About extension points](/main/docs/about-extension-points)