List tool set events

$ cadenya tool-sets list-events

GET/v1/tool_sets/{toolSetId}/events

Lists all events (including sync status) for a tool set

ParametersExpand Collapse

--tool-set-id: string

--cursor: optional string

Pagination cursor from previous response

--include-info: optional boolean

When set to true you may use more of your alloted API rate-limit

--limit: optional number

Maximum number of results to return

--sort-order: optional string

Sort order for results (asc or desc by creation time)

ReturnsExpand Collapse

ListToolSetEventsResponse: object { items, pagination }

items: optional array of ToolSetEvent { metadata, event, info, toolSetId }

metadata: object { id, accountId, createdAt, 4 more }

Metadata for ephemeral operations and activities (e.g., objectives, executions, runs)

id: string

Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...")

accountId: string

Account this operation belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying

profileId: string

ID of the actor (user or service account) that created this operation

workspaceId: string

Workspace this operation belongs to for organizational grouping (prefixed ULID)

externalId: optional string

External ID for the operation (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"}

event: optional object { syncCompleted, syncFailed, syncStarted, type }

ToolSetEventData represents the actual event payload for tool set operations

syncCompleted: optional object { message, toolsSynced }

SyncCompleted is emitted when a tool set sync operation completes successfully

message: optional string

Optional message with additional details

toolsSynced: optional number

Number of tools synced

syncFailed: optional object { error, errorType, message }

SyncFailed is emitted when a tool set sync operation fails

error: optional boolean

Indicates this is an error event

errorType: optional string

Optional error type/code for programmatic handling

message: optional string

Error message describing what went wrong

syncStarted: optional object { message }

SyncStarted is emitted when a tool set sync operation begins

message: optional string

Timestamp when the sync was initiated

type: optional string

Type of the event (e.g., "sync_started", "sync_completed", "sync_failed")

info: optional object { createdBy, toolSet }

createdBy: optional object { metadata, spec }

Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS).

metadata: object { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: object { type, email, name }

ProfileSpec contains the profile-specific fields

type: "PROFILE_TYPE_USER" or "PROFILE_TYPE_API_KEY" or "PROFILE_TYPE_SYSTEM"

Type is the type of profile. User's are humans, API keys are computers. You know the deal.

"PROFILE_TYPE_USER"

"PROFILE_TYPE_API_KEY"

"PROFILE_TYPE_SYSTEM"

email: optional string

Email address of the user (required, unique per account)

Display name for the user (e.g., "Bobby Tables")

toolSet: optional object { id, accountId, createdAt, 5 more }

Standard metadata for persistent, named resources (e.g., agents, tools, prompts)

id: string

Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

createdAt: string

Timestamp when this resource was created

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

ID of the actor (user or service account) that created this resource

workspaceId: string

Workspace this resource belongs to for organizational grouping (prefixed ULID)

externalId: optional string

External ID for the resource (e.g., a workflow ID from an external system)

labels: optional map[string]

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

toolSetId: optional string

The tool set this event is associated with

pagination: optional object { nextCursor, total }

nextCursor: optional string

total: optional number

List tool set events

cadenya tool-sets list-events \
  --api-key 'My API Key' \
  --tool-set-id toolSetId

{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "event": {
        "syncCompleted": {
          "message": "message",
          "toolsSynced": 0
        },
        "syncFailed": {
          "error": true,
          "errorType": "errorType",
          "message": "message"
        },
        "syncStarted": {
          "message": "message"
        },
        "type": "type"
      },
      "info": {
        "createdBy": {
          "metadata": {
            "id": "id",
            "accountId": "accountId",
            "name": "name",
            "profileId": "profileId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          },
          "spec": {
            "type": "PROFILE_TYPE_USER",
            "email": "email",
            "name": "name"
          }
        },
        "toolSet": {
          "id": "id",
          "accountId": "accountId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "name": "name",
          "profileId": "profileId",
          "workspaceId": "workspaceId",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        }
      },
      "toolSetId": "toolSetId"
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}

Returns Examples

{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "event": {
        "syncCompleted": {
          "message": "message",
          "toolsSynced": 0
        },
        "syncFailed": {
          "error": true,
          "errorType": "errorType",
          "message": "message"
        },
        "syncStarted": {
          "message": "message"
        },
        "type": "type"
      },
      "info": {
        "createdBy": {
          "metadata": {
            "id": "id",
            "accountId": "accountId",
            "name": "name",
            "profileId": "profileId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          },
          "spec": {
            "type": "PROFILE_TYPE_USER",
            "email": "email",
            "name": "name"
          }
        },
        "toolSet": {
          "id": "id",
          "accountId": "accountId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "name": "name",
          "profileId": "profileId",
          "workspaceId": "workspaceId",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        }
      },
      "toolSetId": "toolSetId"
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}