> ## Documentation Index > Fetch the complete documentation index at: https://docs.omnara.com/llms.txt > Use this file to discover all available pages before exploring further. # Get cron trigger > Returns one cron trigger: its target, schedule, timezone, message template, enabled flag, and firing state (last_fired_at, next_fire_at, and any failure since the last successful firing). ## OpenAPI ````yaml /api-reference/openapi.yaml get /orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID} openapi: 3.1.2 info: title: Omnara API version: 0.1.0 description: Public HTTP API contract for Omnara. servers: - url: https://api.omnara.com/v1 description: Hosted Omnara - url: /api/v1 description: Self-hosted Omnara, relative to the deployment origin security: - bearerAuth: [] - browserSessionCookie: [] tags: - name: Agents description: >- Launch agents, send inputs, manage the input backlog, and work with tool calls. externalDocs: description: Guide url: https://docs.omnara.com/agents/overview - name: Interactions description: List and resolve the approvals and questions that pause an agent. externalDocs: description: Guide url: https://docs.omnara.com/events/interactions - name: Actors description: Attribute agent inputs and interaction responses to external users. externalDocs: description: Guide url: >- https://docs.omnara.com/events/sending-input#who-said-that-actors-and-attribution - name: Events description: Read or stream the agent timeline, list turns, and download artifacts. externalDocs: description: Guide url: https://docs.omnara.com/events/streaming - name: Configs and Profiles description: >- Create agent configs, manage reusable launch profiles, and set up integrations. externalDocs: description: Guide url: https://docs.omnara.com/agents/configuration - name: Integrations description: >- Connect project integrations, route conversations, and manage launch settings. externalDocs: description: Guide url: https://docs.omnara.com/integrations/overview - name: Models description: Configure model providers and models, and grant projects access to them. externalDocs: description: Guide url: https://docs.omnara.com/organization/model-providers - name: Machines description: Register machines, control project access, and manage daemon tokens. externalDocs: description: Guide url: https://docs.omnara.com/machines/connect - name: Machine Pools description: Define machine pools and grant projects access to them. externalDocs: description: Guide url: https://docs.omnara.com/machines/pools - name: Secrets description: >- Manage secret ownership and versions, and inspect or grant project availability. externalDocs: description: Guide url: https://docs.omnara.com/organization/secrets - name: Skills description: Manage versioned skill ownership and load skill instructions on demand. externalDocs: description: Guide url: https://docs.omnara.com/tools/skills - name: Organizations and Projects description: Create organizations and projects and manage membership. externalDocs: description: Guide url: https://docs.omnara.com/organization/members - name: Users and API Keys description: >- The authenticated user, personal and organization API keys, and invitations. externalDocs: description: Guide url: https://docs.omnara.com/api/authentication - name: Machine Daemon description: Routes the Omnara machine daemon uses to connect a machine. paths: /orgs/{orgID}/projects/{projectID}/cron-triggers/{cronTriggerID}: parameters: - name: orgID in: path description: Organization ID (org_...). required: true schema: type: string pattern: ^org_[a-z2-7]{26}$ - name: projectID in: path description: Project ID (proj_...). required: true schema: type: string pattern: ^proj_[a-z2-7]{26}$ - name: cronTriggerID in: path description: Cron trigger ID (cron_...). required: true schema: $ref: '#/components/schemas/CronTriggerID' get: tags: - Configs and Profiles summary: Get cron trigger description: >- Returns one cron trigger: its target, schedule, timezone, message template, enabled flag, and firing state (last_fired_at, next_fire_at, and any failure since the last successful firing). operationId: getCronTrigger responses: '200': description: Cron trigger. content: application/json: schema: $ref: '#/components/schemas/CronTrigger' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '503': $ref: '#/components/responses/ServiceUnavailable' 4XX: $ref: '#/components/responses/ClientError' 5XX: $ref: '#/components/responses/ServerError' components: schemas: CronTriggerID: type: string pattern: ^cron_[a-z2-7]{26}$ CronTrigger: type: object additionalProperties: false required: - id - org_id - project_id - name - target - cron - timezone - enabled - last_fired_at - next_fire_at - failure_report - last_run - created_at - updated_at properties: id: $ref: '#/components/schemas/CronTriggerID' org_id: $ref: '#/components/schemas/OrganizationID' project_id: $ref: '#/components/schemas/ProjectID' name: $ref: '#/components/schemas/ResourceName' target: $ref: '#/components/schemas/CronTriggerTarget' cron: $ref: '#/components/schemas/CronExpression' timezone: $ref: '#/components/schemas/CronTimezone' message_template: $ref: '#/components/schemas/CronMessageTemplate' enabled: type: boolean last_fired_at: oneOf: - $ref: '#/components/schemas/Timestamp' - type: 'null' description: >- When the trigger last fired, or null if it has never fired. For integration targets this means durable inbox handoff. next_fire_at: oneOf: - $ref: '#/components/schemas/Timestamp' - type: 'null' description: Next scheduled firing, or null while the trigger is disabled. failure_report: oneOf: - $ref: '#/components/schemas/CronTriggerFailureReport' - type: 'null' description: >- Most recent failed firing, or null if no firing has failed since the last successful firing. last_run: oneOf: - $ref: '#/components/schemas/CronTriggerLastRun' - type: 'null' description: >- Status of the latest accepted scheduled integration launch, scoped to this project and integration. Null for ordinary cron, before any launch is accepted, or when retained details have expired. Never falls back to an older launch. Schedule firing failures remain separate in failure_report. Deleting or disabling a schedule does not cancel launch work already accepted by the integration. created_at: $ref: '#/components/schemas/Timestamp' updated_at: $ref: '#/components/schemas/Timestamp' OrganizationID: type: string pattern: ^org_[a-z2-7]{26}$ ProjectID: description: Project ID (proj_...). type: string pattern: ^proj_[a-z2-7]{26}$ ResourceName: type: string minLength: 1 maxLength: 64 x-omnara-unicode-normalization: NFC description: >- Human-readable name. Spaces and punctuation are allowed; leading or trailing whitespace and invisible or control characters are not. CronTriggerTarget: description: >- What each firing does: type agent sends the message to an existing agent, type profile launches a new agent from a profile, and type integration hands the firing to an integration, such as a new Slack or Discord thread. oneOf: - $ref: '#/components/schemas/AgentCronTriggerTarget' - $ref: '#/components/schemas/AgentProfileCronTriggerTarget' - $ref: '#/components/schemas/IntegrationCronTriggerTarget' discriminator: propertyName: type mapping: agent: '#/components/schemas/AgentCronTriggerTarget' profile: '#/components/schemas/AgentProfileCronTriggerTarget' integration: '#/components/schemas/IntegrationCronTriggerTarget' CronExpression: type: string description: >- Standard five-field cron expression (minute, hour, day of month, month, day of week). `TZ=`/`CRON_TZ=` prefixes are rejected; set the `timezone` field instead. minLength: 9 maxLength: 256 CronTimezone: type: string description: IANA time zone the schedule is evaluated in. default: UTC maxLength: 64 CronMessageTemplate: type: string description: >- Go text/template rendered on each firing to produce the message sent to the target. The template receives a `trigger` value with `name`, `fired_at`, `last_fired_at`, and `local_date` fields. Timestamps remain UTC; local_date is the scheduled occurrence's ISO date in the schedule timezone. Required for agent and profile targets; omitted for integration targets, which use their own settings. Rendering is capped at 64 KiB of output and one second of wall-clock time, and `printf` width and precision specifiers are capped at 1024; a firing whose template fails to render is recorded in `failure_report` without sending a message. maxLength: 65536 Timestamp: type: string format: date-time CronTriggerFailureReport: type: object additionalProperties: false required: - message - will_retry - failed_at properties: message: type: string description: Why the most recent failed firing did not deliver a message. will_retry: type: boolean description: Whether the firing will be retried after the claim lease expires. failed_at: $ref: '#/components/schemas/Timestamp' CronTriggerLastRun: type: object additionalProperties: false required: - state - created_at - updated_at - failure_message properties: state: $ref: '#/components/schemas/CronTriggerLastRunState' created_at: $ref: '#/components/schemas/Timestamp' updated_at: $ref: '#/components/schemas/Timestamp' failure_message: type: - string - 'null' description: Coarse scheduled action failure description; no raw provider errors. Error: type: object additionalProperties: false required: - error - code properties: error: type: string description: Human-readable error message. Do not match on it programmatically. current_digest: type: string pattern: ^sha256:[0-9a-f]{64}$ description: >- Current file digest for file_content_conflict or expected_digest_required; absent if the file no longer exists. A replacement must be confirmed before retrying with this digest. issues: type: array description: >- Field-level problems when a submitted document (such as an agent config source) failed validation. Absent for errors that are not about a specific field. items: $ref: '#/components/schemas/AgentConfigErrorIssue' code: type: string description: Stable error code for programmatic handling. x-go-type: ErrorCode x-extensible-enum: - invalid_request - unauthorized - forbidden - not_found - conflict - file_content_conflict - file_read_only - expected_digest_required - not_a_file - gone - request_too_large - unsupported_media_type - unprocessable - upstream_unavailable - rate_limited - internal_error - service_unavailable - idempotency_key_conflict - agent_backlog_full - state_transition_conflict - managed_work_admission_denied - pending_work - not_wake_capable - daemon_runtime_unregistered - validation_failed - csrf_check_failed - authentication_unavailable ClientErrorCode: type: string description: >- Stable error code carried by 4XX statuses. Subset of the Error code enum whose statuses are client errors. x-extensible-enum: - invalid_request - validation_failed - unauthorized - forbidden - csrf_check_failed - not_found - conflict - file_content_conflict - file_read_only - expected_digest_required - not_a_file - idempotency_key_conflict - agent_backlog_full - state_transition_conflict - pending_work - not_wake_capable - gone - daemon_runtime_unregistered - request_too_large - unsupported_media_type - unprocessable - upstream_unavailable - rate_limited ServerErrorCode: type: string description: >- Stable error code carried by 5XX statuses. Subset of the Error code enum whose statuses are server errors. x-extensible-enum: - internal_error - service_unavailable - authentication_unavailable AgentCronTriggerTarget: type: object additionalProperties: false required: - type - agent_id properties: type: type: string enum: - agent agent_id: $ref: '#/components/schemas/AgentID' delivery_mode: $ref: '#/components/schemas/CronTriggerDeliveryMode' AgentProfileCronTriggerTarget: type: object additionalProperties: false required: - type - agent_profile_id properties: type: type: string enum: - profile agent_profile_id: $ref: '#/components/schemas/AgentProfileID' IntegrationCronTriggerTarget: type: object additionalProperties: false required: - type - integration_id - settings properties: type: type: string enum: - integration x-enum-varnames: - IntegrationCronTriggerTargetTypeIntegration integration_id: $ref: '#/components/schemas/IntegrationID' settings: type: object additionalProperties: true description: >- Settings validated by the target integration's published schedule input schema. Each accepted occurrence retains its own copy. Integration resource references are resolved when the integration handles the occurrence. CronTriggerLastRunState: type: string enum: - queued - processing - completed - failed x-enum-varnames: - CronTriggerLastRunStateQueued - CronTriggerLastRunStateProcessing - CronTriggerLastRunStateCompleted - CronTriggerLastRunStateFailed description: >- State of the latest accepted scheduled integration action. Completed means the integration handled the occurrence; it does not indicate completion of any agent task that action started. AgentConfigErrorIssue: type: object additionalProperties: false required: - path - message properties: path: type: string description: >- JSON Pointer (RFC 6901) to the offending field in the submitted document. An empty string refers to the whole document. message: type: string description: Human-readable description of the problem with this field. line: type: integer minimum: 1 description: >- 1-based line of the offending field in the submitted source, when it can be located. column: type: integer minimum: 1 description: >- 1-based column of the offending field in the submitted source, when it can be located. AgentID: type: string pattern: ^agt_[a-z2-7]{26}$ CronTriggerDeliveryMode: type: string enum: - queued - steering description: >- Each firing sends a queued or steering message to the agent. Defaults to `queued` on creation; omitted updates preserve the current mode. AgentProfileID: type: string pattern: ^aprf_[a-z2-7]{26}$ IntegrationID: type: string pattern: ^itg_[a-z2-7]{26}$ responses: BadRequest: description: The request was invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: Authentication is required or invalid. content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: The authenticated principal is not authorized. content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: The requested resource was not found or is not visible. content: application/json: schema: $ref: '#/components/schemas/Error' ServiceUnavailable: description: The service dependency required to satisfy the request is unavailable. content: application/json: schema: $ref: '#/components/schemas/Error' ClientError: description: >- Any other client error. The body carries the shared Error envelope restricted to client error codes; statuses with a dedicated response above are documented precisely. content: application/json: schema: type: object additionalProperties: false required: - error - code properties: error: type: string description: >- Human-readable error message. Do not match on it programmatically. code: $ref: '#/components/schemas/ClientErrorCode' ServerError: description: >- Any other server error. The body carries the shared Error envelope restricted to server error codes. content: application/json: schema: type: object additionalProperties: false required: - error - code properties: error: type: string description: >- Human-readable error message. Do not match on it programmatically. code: $ref: '#/components/schemas/ServerErrorCode' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Omnara personal or organization access token description: An opaque Omnara personal or organization bearer token. browserSessionCookie: type: apiKey in: cookie name: __Host-omnara_session description: >- Browser session cookie. HTTPS deployments use __Host-omnara_session; local HTTP development uses omnara_session. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.