Skip to main content

autessa.scheduledEvents

Scheduled and recurring jobs.

autessa.scheduledEvents.allREAD

autessa.scheduledEvents.all()

List every scheduled event you can access, grouped into ownedEvents, companySharedEvents, and sharedWithMeEvents (no pagination).

Returns your accessible scheduled events in the current company split into three buckets: events you own, events shared company-wide, and events shared specifically with you. Each carries your effective userPermission. Not paginated.

Request fields

No fields.

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    ownedEvents
    Type
    ScheduledEventTriggerDto[]
    Description
  • Name
    companySharedEvents
    Type
    ScheduledEventTriggerDto[]
    Description
  • Name
    sharedWithMeEvents
    Type
    ScheduledEventTriggerDto[]
    Description

autessa.scheduledEvents.createMUTATE

autessa.scheduledEvents.create({ eventName, description, scheduleSpec, enabled, actionType, agentConfig, toolConfig, autessaDbConfig })

Create a scheduled event that invokes an agent, executes a tool, or writes AutessaDB rows on a recurring rate, cron, or one-time schedule.

Required: eventName, actionType, exactly the config object matching the actionType, and scheduleSpec. Provide agentConfig for INVOKE_AGENT, toolConfig for INVOKE_TOOL, or autessaDbConfig for UPDATE_AUTESSADB (SYSTEM_TASK is an internal platform action and is not created through this API). You must already have access to the agent, tool, or table the action targets — the event later runs under the owner/company-admin identity, so the creator's access is checked up front. The new event is owned by you with ADMIN access.

Request fields

  • Name
    eventName
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description
  • Name
    scheduleSpec
    Type
    object
    Description
  • Name
    enabled
    Type
    boolean
    Description
  • Name
    actionType
    Type
    "INVOKE_AGENT" | "INVOKE_TOOL" | "UPDATE_AUTESSADB" | "SYSTEM_TASK"
    Description
  • Name
    agentConfig
    Type
    ScheduledInvokeAgentActionConfig
    Description
  • Name
    toolConfig
    Type
    ScheduledInvokeToolActionConfig
    Description
  • Name
    autessaDbConfig
    Type
    ScheduledUpdateAutessaDbActionConfig
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    scheduledEvent
    Type
    ScheduledEventTriggerDto
    Description
  • Name
    eventId
    Type
    string
    Description
  • Name
    scheduleArn
    Type
    string
    Description

autessa.scheduledEvents.deleteMUTATE

autessa.scheduledEvents.delete({ scheduledEventId })

Delete a scheduled event and remove its underlying schedule; a deleted event cannot be re-enabled or updated.

Irreversible. Removes both the event record and the underlying AWS schedule so it stops firing. Requires ADMIN access.

Request fields

  • Name
    scheduledEventId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    eventId
    Type
    string
    Description
  • Name
    deletedAt
    Type
    string (ISO 8601)
    Description

autessa.scheduledEvents.getREAD

autessa.scheduledEvents.get({ scheduledEventId })

Fetch one scheduled event by scheduledEventId, including your permission level.

Returns the full event — its schedule, action config, sharing, and execution counters — plus your effective permission on it. Read-modify-submit from here when calling scheduledEvents.update.

Request fields

  • Name
    scheduledEventId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    permission
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    scheduledEvent
    Type
    ScheduledEventTriggerDto
    Description

autessa.scheduledEvents.getSharingDetailsREAD

autessa.scheduledEvents.getSharingDetails({ scheduledEventId })

Get a scheduled event's sharing level, company-wide permission, per-user grants, and your own access level.

Read-only view of exactly what scheduledEvents.share would modify.

Request fields

  • Name
    scheduledEventId
    Type
    string
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    sharingLevel
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    companyPermissionLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    sharedWith
    Type
    UserShareWrapper[]
    Description
  • Name
    userAccessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description

autessa.scheduledEvents.historyREAD

autessa.scheduledEvents.history({ scheduledEventId, page, month, year })

Page through execution history and monthly success/failure stats for one scheduled event (or all company events if scheduledEventId is omitted) for a given month and year.

Returns one page of executions plus company-wide monthly counters. page is 0-based and the page size is fixed at 50; month (1-12) and year default to the current month. When you filter by scheduledEventId the filter is applied after each page is fetched, so a page can come back short or empty and totalElements only counts the current page's matches — iterate on hasNext, not on a page being full. averageDurationMs is only computed when a single scheduledEventId is given (null otherwise); the success/failure counters cover every event in the month unless a scheduledEventId narrows them.

Request fields

  • Name
    scheduledEventId
    Type
    string
    Description
  • Name
    page
    Type
    number
    Description
  • Name
    month
    Type
    number
    Description
  • Name
    year
    Type
    number
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    executions
    Type
    ScheduledEventHistoryDto[]
    Description
  • Name
    totalElements
    Type
    number
    Description
  • Name
    totalPages
    Type
    number
    Description
  • Name
    currentPage
    Type
    number
    Description
  • Name
    pageSize
    Type
    number
    Description
  • Name
    hasNext
    Type
    boolean
    Description
  • Name
    hasPrevious
    Type
    boolean
    Description
  • Name
    successCount
    Type
    number
    Description
  • Name
    failedCount
    Type
    number
    Description
  • Name
    successRate
    Type
    number
    Description
  • Name
    averageDurationMs
    Type
    number
    Description

autessa.scheduledEvents.shareMUTATE

autessa.scheduledEvents.share({ scheduledEventId, level, accessLevel, usersToAdd, usersToRemove })

Set a scheduled event's sharing mode: PRIVATE, COMPANY-wide at one access level, or SPECIFIC_MEMBER with per-user grants via usersToAdd/usersToRemove.

Requires ADMIN access. A share call that cannot be applied (for example a grant that changes nothing) returns an error, not success.

Request fields

  • Name
    scheduledEventId
    Type
    string
    Description
  • Name
    level
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description
  • Name
    accessLevel
    Type
    "READ" | "WRITE" | "PUBLISH" | "ADMIN"
    Description
  • Name
    usersToAdd
    Type
    UserShareWrapper[]
    Description
  • Name
    usersToRemove
    Type
    UserShareWrapper[]
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    eventId
    Type
    string
    Description
  • Name
    sharingLevel
    Type
    "PRIVATE" | "SPECIFIC_MEMBER" | "COMPANY"
    Description

autessa.scheduledEvents.toggleMUTATE

autessa.scheduledEvents.toggle({ scheduledEventId, enabled })

Enable or disable a scheduled event's firing via the required boolean enabled field.

Set enabled true to resume firing, false to pause. Requires WRITE or ADMIN. A deleted event cannot be re-enabled.

Request fields

  • Name
    scheduledEventId
    Type
    string
    Description
  • Name
    enabled
    Type
    boolean
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    eventId
    Type
    string
    Description
  • Name
    enabled
    Type
    boolean
    Description

autessa.scheduledEvents.updateMUTATE

autessa.scheduledEvents.update({ scheduledEventId, eventName, description, scheduleSpec, actionType, agentConfig, toolConfig, autessaDbConfig })

Update a scheduled event's name, schedule, and/or action config by submitting the complete desired state (read with scheduledEvents.get, modify, submit).

The submitted configuration replaces the stored one wholesale — omitted fields are lost, so start from the event returned by scheduledEvents.get. Requires WRITE or ADMIN, plus access to any newly targeted agent/tool/table. A deleted event cannot be updated.

Request fields

  • Name
    scheduledEventId
    Type
    string
    Description
  • Name
    eventName
    Type
    string
    Description
  • Name
    description
    Type
    string
    Description
  • Name
    scheduleSpec
    Type
    object
    Description
  • Name
    actionType
    Type
    "INVOKE_AGENT" | "INVOKE_TOOL" | "UPDATE_AUTESSADB" | "SYSTEM_TASK"
    Description
  • Name
    agentConfig
    Type
    ScheduledInvokeAgentActionConfig
    Description
  • Name
    toolConfig
    Type
    ScheduledInvokeToolActionConfig
    Description
  • Name
    autessaDbConfig
    Type
    ScheduledUpdateAutessaDbActionConfig
    Description

Response fields

  • Name
    errors
    Type
    string[]
    Description
  • Name
    deprecationWarnings
    Type
    string[]
    Description
  • Name
    sessionToken
    Type
    string
    Description
  • Name
    scheduledEvent
    Type
    ScheduledEventTriggerDto
    Description