Dependency graph

Overview

Configly analyses the relationships between your Zendesk config objects and exposes them through the dependency graph endpoints. A forward dependency describes what a given object uses (for example, a trigger that references a specific group). A reverse dependency describes what uses a given object (for example, all triggers that reference a particular group).

These endpoints also include orphan detection, which identifies objects that no other config item references.

List all dependencies

GET /v1/connections/:connectionId/dependencies

Returns a paginated list of all forward dependencies across the latest snapshot. You can narrow the results with optional filters.

Query parameters

Example request

curl "https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/dependencies?sourceType=triggers&page=1&limit=20" \
  -H "Authorization: Bearer cly_your_key"

Forward dependencies for an object

GET /v1/connections/:connectionId/dependencies/:type/:objectId

Returns what a specific object uses. The :objectId must be a numeric Zendesk ID.

Example request

curl https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/dependencies/triggers/12345 \
  -H "Authorization: Bearer cly_your_key"

Example response

{
  "data": {
    "object": {
      "type": "triggers",
      "id": "12345",
      "name": "Auto-close solved tickets"
    },
    "dependencies": [
      {
        "sourceType": "triggers",
        "sourceId": "12345",
        "sourceName": "Auto-close solved tickets",
        "targetType": "groups",
        "targetId": "99",
        "targetName": "Support",
        "location": "conditions.all[0]"
      }
    ],
    "count": 1
  }
}

Reverse dependencies

GET /v1/connections/:connectionId/dependencies/:type/:objectId/reverse

Returns what uses a specific object. The response includes a usedBy array listing every config item that references the target.

Example request

curl https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/dependencies/groups/99/reverse \
  -H "Authorization: Bearer cly_your_key"

Example response

{
  "data": {
    "object": {
      "type": "groups",
      "id": "99",
      "name": "Support"
    },
    "usedBy": [
      {
        "type": "triggers",
        "id": "12345",
        "name": "Auto-close solved tickets",
        "location": "conditions.all[0]"
      }
    ],
    "count": 1
  }
}

Orphan detection

GET /v1/connections/:connectionId/orphans

Returns config objects that are not referenced by any other object in the latest snapshot. Results are grouped by config type. Use the optional type query parameter to narrow results to a single type.

Example request

curl "https://api.configly.app/v1/connections/YOUR_CONNECTION_ID/orphans?type=macros" \
  -H "Authorization: Bearer cly_your_key"

Example response

{
  "data": {
    "macros": [
      {
        "type": "macros",
        "id": "555",
        "name": "Unused greeting macro",
        "createdAt": "2025-01-15T10:30:00.000Z"
      }
    ]
  },
  "meta": {
    "total": 1
  }
}

Dependency response shape

Each dependency in the paginated list and forward-dependency endpoints uses this structure:

Error codes