A schedule-based trigger runs a workflow on a cron schedule. The cron expression is evaluated by Temporal. Every supported cron form, predefined macro, and time zone clause works the same way.

Cron format

The Workflow API accepts standard 5-field cron expressions, predefined macros, and an optional time-zone prefix.

⚠️

Time zone defaults to UTC. If your business runs on Asia/Manila or another local time zone, prefix the cron with CRON_TZ=Asia/Manila or you may run a daily job 8 hours later than expected.

Common patterns

Examples

Daily settlement

Run the workflow every day at 09:00 Manila time:

curl --request POST 'https://workflow-api.paymongo.com/v1/triggers' \
  --header 'Authorization: Basic ${YOUR_BASIC_TOKEN}' \
  --header 'Organization-Id: ${YOUR_ORG_ID}' \
  --header 'Content-Type: application/json' \
  --data '{
    "workflow_id": "wf_abc123",
    "condition": {
      "schedule": "CRON_TZ=Asia/Manila 0 9 * * *"
    }
  }'

Response:

{
  "id": "trg_xyz",
  "workflow_id": "wf_abc123",
  "state": "active",
  "condition": {"schedule": "CRON_TZ=Asia/Manila 0 9 * * *"},
  "livemode": true,
  "created_at": "...",
  "updated_at": "..."
}

Weekly sweep

Sweep wallets every Monday at 09:00 Manila time:

curl --request POST 'https://workflow-api.paymongo.com/v1/triggers' \
  --header 'Authorization: Basic ${YOUR_BASIC_TOKEN}' \
  --header 'Organization-Id: ${YOUR_ORG_ID}' \
  --header 'Content-Type: application/json' \
  --data '{
    "workflow_id": "wf_sweep",
    "condition": {
      "schedule": "CRON_TZ=Asia/Manila 0 9 * * 1"
    }
  }'

What the workflow sees

When a schedule fires, the workflow input is empty ({}). Schedule-based workflows must rely on data they read at runtime (for example, with get_wallet_balance ) rather than data passed in by the trigger.

One-shot scheduling

The Workflow API does not currently support one-shot schedules (a single cron fire at a specific timestamp). For one-shot behaviour, create a recurring trigger and delete it after the first instance fires:

# Step 1: create the trigger
# (see Quickstart for the full payload)

# Step 2: delete after the first fire
curl --request DELETE 'https://workflow-api.paymongo.com/v1/triggers/${TRIGGER_ID}' \
  --header 'Authorization: Basic ${YOUR_BASIC_TOKEN}' \
  --header 'Organization-Id: ${YOUR_ORG_ID}'

See Also

• Event-Based Triggers: the event-driven alternative.
• Sweep Wallets on a Schedule: a production pattern using a daily schedule.
• Create a Trigger: full request and response reference.