Skip to main content
Version: Early Access

Agility Connect API Documentation

This topic explains how to get started with Agility Connect APIs.

Overview​

Agility Connect APIs help you integrate with external systems such as Jira, Azure DevOps, and (Undefined variable: Global Variables.d.teamforge) and allow direct queries to Agility Connect. The sync between such ALM systems happens through webhooks via a Python-based framework.

Agility Connect codebase comprises of two major components:

  • Mapping (AgilitySync.mapping) is the Python package used to get asset-related information from ALM systems based on their configuration in the plugin system Agility Connect provides. It is also used for
    • Creating mappings between any supported ALM system and Digital.ai Agility to aid live syncing of data between the two ALM systems, and
    • To migrate data from an ALM system into Digital.ai Agility.
  • Sync (AgilitySync.sync) is the Python package used to sync data between ALM systems ensuring that the data in both systems are identical. It operates based on information about changes to the mapped assets or workitems received via webhooks.

Refer to the Agility Connect API Documentation for detailed information.