List tool set events

tool_sets.list_events(tool_set_id, **kwargs) -> CursorPagination<ToolSetEvent { metadata, event, info, tool_set_id } >

GET/v1/workspaces/{workspaceId}/tool_sets/{toolSetId}/events

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

ParametersExpand Collapse

workspace_id: String

tool_set_id: String

cursor: String

Pagination cursor from previous response

include_info: bool

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

limit: Integer

Maximum number of results to return

formatint32

sort_order: String

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

ReturnsExpand Collapse

class ToolSetEvent { metadata, event, info, tool_set_id }

A single event in the tool set’s operation timeline.

metadata: OperationMetadata { id, account_id, created_at, 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…”)

account_id: String

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

created_at: Time

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

formatdate-time

profile_id: String

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

workspace_id: String

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

external_id: String

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

labels: Hash[Symbol, String]

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

event: ToolSetEventData { sync_completed, sync_failed, sync_started, type }

Event payload for a tool set operation.

sync_completed: SyncCompleted { message, tools_synced }

Emitted when a tool set sync operation completes successfully.

message: String

Optional message with additional details.

tools_synced: Integer

Number of tools synced.

formatint32

sync_failed: SyncFailed { error, error_type, message }

Emitted when a tool set sync operation fails.

error: bool

Indicates this is an error event.

error_type: String

Optional error type/code for programmatic handling.

message: String

Error message describing what went wrong.

sync_started: SyncStarted { message }

Emitted when a tool set sync operation begins.

message: String

Human-readable message describing the start of the sync.

type: String

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

info: Info{ created_by, tool_set}

created_by: Profile { metadata, spec }

A profile identifies a user or non-human principal (such as an API key) at the account level. Profiles are account-scoped and can be granted access to multiple workspaces.

metadata: AccountResourceMetadata { id, account_id, 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…”)

account_id: 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

profile_id: String

external_id: String

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

labels: Hash[Symbol, String]

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

spec: ProfileSpec { type, email, name }

Configuration for a profile.

type: :PROFILE_TYPE_UNSPECIFIED | :PROFILE_TYPE_USER | :PROFILE_TYPE_API_KEY | :PROFILE_TYPE_SYSTEM

Whether this profile represents a human user, an API key, or a system principal.

formatenum

One of the following:

:PROFILE_TYPE_UNSPECIFIED

:PROFILE_TYPE_USER

:PROFILE_TYPE_API_KEY

:PROFILE_TYPE_SYSTEM

email: String

Email address of the profile. Required and unique within an account for user profiles.

Display name (e.g., “Bobby Tables”).

tool_set: ResourceMetadata { id, account_id, created_at, 6 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…”)

account_id: String

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

created_at: Time

Timestamp when this resource was created

formatdate-time

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

profile_id: String

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

workspace_id: String

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

bundle_key: String

Optional bundle ownership key. When set, indicates the resource is managed by a configuration bundle identified by this key. Used by BulkWorkspaceResources.Apply to track which resources belong to which bundle for reconciliation / soft-delete on re-apply.

external_id: String

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

labels: Hash[Symbol, String]

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

tool_set_id: String

The tool set this event is associated with.

List tool set events

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

page = cadenya.tool_sets.list_events("toolSetId", workspace_id: "workspaceId")

puts(page)

{
  "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_UNSPECIFIED",
            "email": "email",
            "name": "name"
          }
        },
        "toolSet": {
          "id": "id",
          "accountId": "accountId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "name": "name",
          "profileId": "profileId",
          "workspaceId": "workspaceId",
          "bundleKey": "bundleKey",
          "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_UNSPECIFIED",
            "email": "email",
            "name": "name"
          }
        },
        "toolSet": {
          "id": "id",
          "accountId": "accountId",
          "createdAt": "2019-12-27T18:11:19.117Z",
          "name": "name",
          "profileId": "profileId",
          "workspaceId": "workspaceId",
          "bundleKey": "bundleKey",
          "externalId": "externalId",
          "labels": {
            "foo": "string"
          }
        }
      },
      "toolSetId": "toolSetId"
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}