# Waitpoints

Sydekyks user and operator guide. Check feature availability and release-specific installation requirements.

A waitpoint is the durable row that represents a paused step on a flow run. The flow run row only carries status (PAUSED, RUNNING, …); the why lives on the waitpoint.

## ​Schema

 | Field | Meaning

 | flowRunId, stepName | Which run/step is paused. Unique together. stepName is path-qualified for a step inside a loop (loop_1:3/approval), so each iteration gets its own row.

 | type | DELAY, WEBHOOK or BARRIER.

 | status | PENDING until the resume signal arrives, then COMPLETED.

 | resumeDateTime | For DELAY: when to fire the resume.

 | responseToSend | For WEBHOOK: optional HTTP response returned immediately to the original webhook trigger.

 | resumePayload | { body, headers, queryParams } from the resume call, surfaced to the piece as ctx.resumePayload.

 | sealed | BARRIER only: no more signals will be added.

 | policy | BARRIER only: { requiredSuccesses?, releaseOnFirstFailure?, reasonRequiredOn? }.

## ​Types

- DELAY: resumes at resumeDateTime. The server schedules a one-time job for that timestamp. The delay is bounded by a configurable server-side maximum.

- WEBHOOK: resumes on any HTTP call to the waitpoint’s resume URL. If responseToSend is set, it is replied immediately to the original trigger so a single webhook can respond-then-pause.

- BARRIER: resumes once every awaited thing has reported back. See below.

## ​Barriers

A barrier pauses a run until N things report back - the batches a Process in Batches step dispatched,
or the approvers on one approval. It is a waitpoint plus one signal row per awaited thing, created up
front:

 | Field | Meaning

 | id | Primary key and the resume-link token. Random and unguessable, so possession of one link never lets you forge another.

 | refId | What the signal stands for - the child run id, or the approval link.

 | sequence | The producer’s ordinal (batch index). Null when the producer needs no second idempotency key.

 | label | The human name in the summary - an approver’s email, a branch path. Never a credential.

 | status | PENDING until it reports, then SUCCEEDED / FAILED / REJECTED / CANCELED / NOT_DISPATCHED.

 | result | A small bounded payload - the outcome, the run id, or an approver’s reason.

Release is an unconditional floor rule: a sealed barrier releases once no signal is still PENDING. No
configuration can produce a hang. policy only ever releases sooner - requiredSuccesses covers 2-of-3
approvals, releaseOnFirstFailure covers a veto. Signals left pending at an early release are reported
truthfully as stillRunning.

The step resumes with one shape, so an expression never breaks on fan-out width:

```
{ "total": 3, "succeeded": 2, "failed": 1, "rejected": 0, "canceled": 0,
  "notDispatched": 0, "stillRunning": 0, "timedOut": false,
  "signals": [ { "sequence": 0, "label": null, "outcome": "SUCCEEDED", "result": null, "runId": "..." } ] }

```

The signals array is present only when total <= 100; above that only the counts travel and
signalsTruncated is set. AP_MAX_BARRIER_SIGNALS (default 10 000) caps how many things one barrier may
wait on. The cap is stored per platform, created from the env var the first time that platform’s
configuration is read. 10 000 is also the ceiling: the env var cannot raise it higher. A barrier’s deadline is set when it is created, from AP_PAUSED_FLOW_TIMEOUT_DAYS, and never moves.

## ​Lifecycle

- Create. The piece calls ctx.run.createWaitpoint({ type, ... }) + ctx.run.waitForWaitpoint(id). The engine marks the step as paused and asks the server to insert a PENDING row. The insert is idempotent on the (flow run, step) pair.

- Checkpoint. The engine serializes the execution context and transitions the flow run to PAUSED.

- Resume signal. Either an HTTP call on the resume URL or the scheduled job firing. Both carry { body, headers, queryParams }.

- Re-run. A worker rebuilds the context and re-invokes the same action with ctx.executionType === ExecutionType.RESUME and ctx.resumePayload populated.

## ​Resume-before-pause race

A callback can arrive before the flow run has finished writing PAUSED to disk. The protocol absorbs the race:

- Completing a waitpoint takes a write lock on the PENDING row. If it exists, it flips to COMPLETED and stores the resumePayload. If it does not, a pre-completed row is inserted instead.

- When the flow run transitions to PAUSED, the server checks for a COMPLETED waitpoint on the run and enqueues the resume job immediately - but only once no waitpoint for that run is still PENDING. A run holding a pause per loop iteration can carry a completed leftover and an open pause at the same time, and resuming off the leftover would skip the open one.

Duplicate callbacks are absorbed by the uniqueness constraint; the engine never processes a resume twice.

## ​Endpoints

 | Method | Path | Notes

 | POST | /v1/waitpoints | Engine-only. Creates a PENDING waitpoint, returns its resume URL. For BARRIER, also creates its signals.

 | ALL | /v1/flow-runs/:id/signals/:signalId/confirm | Records one signal’s outcome. GET/HEAD serve the page and never decide; only POST does.

 | ALL | /v1/flow-runs/:id/waitpoints/:waitpointId | Resume, async.

 | ALL | /v1/flow-runs/:id/waitpoints/:waitpointId/sync | Resume, sync. The HTTP response is whatever the flow produces after resuming.

## ​Piece API

Piece authors create waitpoints with ctx.run.createWaitpoint / ctx.run.waitForWaitpoint. Patterns for WEBHOOK, DELAY, and responseToSend are in Flow Control.

## ​Known limitation

findPendingByVersion - the lookup behind the deprecated V0 /:id/requests/:requestId resume routes .
returns an arbitrary pending V0 waitpoint for a run. That is exact today because nothing gives one run two
pending V0 waitpoints at once. Parallel branches would, and must fix this lookup first.