v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB
Wake

Create a wake schedule

Create a cron schedule that sends a wake.dispatch command to one of your own function addresses. from and to must differ (no self-dispatch); the cron expression and IANA timezone are validated and the first fire time is computed without firing immediately.

post/wake/schedules

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

from_addressstring required

Sending identity (must be a domain the org can sign).

target_addressstring required

Your function address (must differ from from_address).

commandstring required
argsobject

Optional JSON object passed through to the woken function.

cron_exprstring required
timezonestring
notestring

Response

Wake schedule created

successtrue required