Routines

Jobs Bash runs on a schedule in plain words, or whenever your system calls.

Send Authorization: Bearer vk_test_... on every call. Every route of Routines.

GET/v1/routines/{routine_id}One routine.

Your API key, scope runtime or all. On the card: routines. Over HTTP it is made from the contract: fill in each {…} and every value.

Request1 field

Path

routine_idstringrequiredThe routine's id (rtn_...).

Type: string

Answers 20017 fields

idstringThe routine's id.

Example: rtn_8f2k

object"routine"Always routine.

Type: "routine"

user_idstring | nullYour id for the user whose Bash runs it; null for your company's own Bash.

Type: string | null

conversation_idstring | nullThe conversation each run posts into, named or made when the routine was; null for a routine not made through the API.

Type: string | null

namestringIts name.

Type: string

askstringWhat Bash is asked on every run.

Type: string

kind"schedule" | "trigger" | "app_event"schedule: it runs on its schedule. trigger: it runs when your system posts to trigger_url. app_event: an event in a connected app runs it.

Type: "schedule" | "trigger" | "app_event"

scheduleobject | nullWhen it runs; null for one that runs on a call.

everystring | nullThe plain words it was given; null for a cron.

Type: string | null

cronstringThe schedule as cron, worked out from every when it was given in words.

Type: string

timezonestringThe zone it runs in, an IANA name.

Type: string

triggerobject | nullFor one that runs on a call, what it listens for; null for one on a schedule.

filtersmap of any | nullWhat a payload must carry for it to run; null: any payload.

Type: map of any | null

trigger_urlstring | nullFor one that runs on a call: POST here, with your key and any JSON object, to run it. Null otherwise.

Type: string | null

enabledbooleanfalse while it is paused.

Type: boolean

status"active" | "completed" | "failed"active: it runs as it should. completed: it has finished and will not run again. failed: it stopped on an error.

Type: "active" | "completed" | "failed"

last_run_atstring | nullWhen it last ran; null when it never has.

Type: string | null

next_run_atstring | nullWhen it runs next; null when paused, finished, or run on a call.

Type: string | null

run_countintegerHow many times it has run.

Type: integer

created_atstringWhen it was made, as an ISO 8601 date and time in UTC.

Type: string

updated_atstringWhen it last changed, as an ISO 8601 date and time in UTC.

Type: string

TypeScript

const routine = await vestra.routines.get('rtn_5kd');

Python

routine = vestra.routines.get("rtn_5kd")

CLI

vestra routines get rtn_5kd

HTTP

No sample in your language for this route, so here it is over HTTP.

curl "$VESTRA_BASE_URL/v1/routines/{routine_id}" \  -H "Authorization: Bearer $VESTRA_API_KEY"