Skip to main content

How to Run an Action (Real-Time, Async, or Scheduled)

When to use live, async or schedule modes.

Written by G

Edges offers three ways to execute actions or workflows via API.

Each suits a different use case:

đŸ”č 1. Live Mode (Synchronous)

  • When to use it: You want results instantly, in real-time.

  • What to expect: You’ll receive paginated data immediately.

  • Heads up: You’ll need to handle rate limiting (429 errors) and pagination yourself.

đŸ”č 2. Async Mode (Asynchronous)

  • When to use it: You don’t need instant results and prefer background processing.

  • What to expect: We’ll send a callback to your webhook when the run completes.

  • Bonus: We handle pagination for you. The results are included in the callback payload.

đŸ”č 3. Schedule Mode (CRON)

  • When to use it: You want to automate recurring jobs (e.g., daily, weekly).

  • What to expect: Runs are triggered based on your CRON expression. Results are sent to your webhook just like async mode.

🌀 Run Lifecycle: What Happens After Launch

Runs (especially async and scheduled) go through different statuses:

  • CREATED → Not yet in queue

  • QUEUED → Waiting to run

  • RUNNING → In progress

  • SUCCEEDED → All good ✅

  • FAILED, BLOCKED, or STOPPED → Something went wrong đŸš«

  • PARTIAL_SUCCEEDED → Mixed results; some data is available

Use this info to track progress and build custom logic.

🛠 Key Endpoints

Here are the most common endpoints you’ll use to manage runs:

Action

Method

Endpoint

List all runs

GET (paginated)

/v1/api/runs/list

Get a run’s details

GET

/v1/api/runs/get?uid=...

Resume a run

POST

/v1/api/runs/{run_uid}/resume

For scheduled runs:

Action

Method

Endpoint

List all schedules

GET (paginated)

/v1/api/schedules/list

Get a schedule

GET

/v1/api/schedules/get?uid=...

Manage (pause/resume)

POST

/v1/api/schedules/manage

đŸ“© Callback Format (Async / Scheduled)

You’ll receive a callback like this when a run is done:

{
  "run": { 
    "run_uid": "string",
    "status": "SUCCEEDED" // or FAILED, etc.
  }, 
  "results": [],
  "error": null
}

Same format every time. Simple and predictable.

🧠 CRON Tips

CRON lets you automate actions on a custom schedule—no manual launching needed.
You build your schedule using five fields:
​minute hour day month day-of-week

How it works:

  • minute: 0–59

  • hour: 0–23 (21 = 9 PM)

  • day: 1–31

  • month: 1–12

  • day-of-week: 0–6 (0 or 7 = Sunday, 1 = Monday, etc.)

Examples:

  • Every day at 2:30 AM: 30 2 * * *

  • Every weekday at 9 PM (Monday–Friday): 0 21 * * 1-5

Need help?

  • Use crontab.guru to build and check your CRON schedule.

  • Or just ask our support team—we’re happy to help review your setup!

📚 Need More Details?

Check out the full guide here: https://docs.edges.run/v1/runs/overview

Did this answer your question?