Skip to main content

UpdateRoutineRequest

@gravity-rail/sdk

@gravity-rail/sdk / UpdateRoutineRequest

Interface: UpdateRoutineRequest

Properties​

agentId?​

optional agentId: number | null

cronString?​

optional cronString: string

description?​

optional description: string

eventRules?​

optional eventRules: EventRuleInput[]

Ordered event rules to attach. Server syncs by UUID: same-UUID rows update, new UUIDs create, UUIDs missing from the list are deleted. Omit the field to leave existing rules untouched.

intervalSeconds?​

optional intervalSeconds: number

limit?​

optional limit: number

memberFilterId?​

optional memberFilterId: number | null

name?​

optional name: string

prompt?​

optional prompt: string | null

repeatCount?​

optional repeatCount: number

rotateWebhookSecret?​

optional rotateWebhookSecret: boolean

Rotate the stored secret without toggling enabled. Ignored when webhookEnabled=false.

scheduledTime?​

optional scheduledTime: string

scheduleEnabled?​

optional scheduleEnabled: boolean

scheduleMode?​

optional scheduleMode: "NONE" | "ONCE" | "CRON" | "INTERVAL" | "MANUAL"

A retired mode may be re-sent unchanged on a disabled row; enabling one is rejected by the server.

skills?​

optional skills: string[] | null

startDate?​

optional startDate: string

ISO 8601 datetime string for deferred start. Pass empty string "" to clear the start date.

targetMemberId?​

optional targetMemberId: number | null

timezone?​

optional timezone: string

IANA timezone the cronString is interpreted in. Pass empty string "" to reset it to the workspace timezone — the server stores that value explicitly rather than clearing the field. Omit to leave unchanged.

visibility?​

optional visibility: "workspace" | "private"

webhookEnabled?​

optional webhookEnabled: boolean

Toggle inbound webhook. Enabling without a stored secret generates one and surfaces plaintext in the response exactly once.

workflowId?​

optional workflowId: number | null