Sign in
Wake

Create a wake schedule

Changed on

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

Request

  • Base URL: https://api.primitive.dev/v1
  • URL: https://api.primitive.dev/v1/wake/schedules
  • Auth: HTTP bearer

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

successboolean required

Changes

  • 52138fa51360Revision changes
    • info

      removed the invalid_signup_code enum value from the / response property for the response status

    • info

      removed the invalid_signup_code enum value from the / response property for the response status

  • 22d1dfc68434Revision changes
    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new not_a_repeating_send enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_idle_requires_internal_recipient enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_recipient_external enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_stop_not_allowed enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status

    • warning

      added the new repeat_unsupported enum value to the / response property for the response status