Create a schedule

/v1/schedules

Runs a saved workflow or bot you own on a cron expression, or once at run_at with schedule "@once". parameters.deliver is a list of {channel, chat_id?, to?} (a bare channel string is widened) with channel one of inapp, email, slack, telegram, whatsapp, discord, teams. A heartbeat takes job_type "heartbeat" and its spec as target. The owner is always the key's user.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Body

application/json
text/yaml

namestringrequired

schedulestringrequired

Cron expression, or "@once" together with run_at

workflow_idstring

The saved workflow or bot to run

job_typeenum<string>

Default workflow

Available options: workflow, heartbeat

targetany

A heartbeat’s spec (object or JSON string); for a workflow schedule the workflow id

descriptionstring

timezonestring

IANA zone the cron is read in

parametersobject

deliver targets, per-run input, …

run_atstring

ISO-8601 time with a UTC offset, in the future; required when schedule is @once

ends_atany

ISO-8601 time or ms epoch after which the schedule stops running

formatenum<string>

Response format override (Accept header and the request Content-Type mirror also work). Default json.

Available options: json, yaml, markdown, text

Response

The schedule Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON.

application/json
text/yaml
text/markdown
text/plain

scheduleobject

Show child attributes

idstring

namestring

descriptionstring | null

job_typeenum<string>

Available options: workflow, heartbeat, agent, query

schedulestring

Cron expression, or @once for a one-time schedule

timezonestring | null

IANA zone the cron is read in; null = UTC

statusenum<string>

Available options: active, paused

workflow_idstring | null

targetstring

The workflow id, or a heartbeat’s JSON spec

parametersobject | null

deliver targets, input, … as stored

next_run_atinteger | null

ms epoch

last_run_atinteger | null

ms epoch

ends_atinteger | null

ms epoch after which a due schedule is removed instead of run

created_atinteger

updated_atinteger

invalid_json / invalid_yaml / invalid_body — unreadable body; invalid_format — format must be one of json, yaml, markdown, text; run_at_required — schedule is @once without run_at; run_at_past — run_at is not in the future; run_at must carry a UTC offset (invalid_request)

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

workflow_not_found — no saved workflow with that id for this key; not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

invalid_params — a field is missing or malformed (the envelope names it); nothing was written

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

scheduler_error — the scheduler failed or did not answer; no detail is returned, retry

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.post( "https://api.plungeai.com/v1/schedules", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, json={ "name": "<string>", "schedule": "<string>", }, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

const response = await fetch('https://api.plungeai.com/v1/schedules', { method: 'POST', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, 'Content-Type': 'application/json', }, body: JSON.stringify({ "name": "<string>", "schedule": "<string>" }), }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) console.log(await response.json())

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/schedules")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .header("Content-Type", "application/json") .POST(HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"schedule\":\"<string>\"}")) .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

{ "schedule": { "id": "<string>", "name": "<string>", "description": "<string>", "job_type": "workflow", "schedule": "<string>", "timezone": "<string>", "status": "active", "workflow_id": "<string>", "target": "<string>", "parameters": {}, "next_run_at": 0, "last_run_at": 0, "ends_at": 0, "created_at": 0, "updated_at": 0 } }

Create a schedule

Authorizations

Body

Response

Planned: TI-33

Planned: TI-34