Skip to content

Concepts

Dry runs (previews)

On this page

Add ?dry_run=true to any write and Bizisy runs it for real, then throws it away. Every check runs: the input, your permission, the business rules (a manager who isn't employed that day, a duplicate email, a reporting cycle), approvals. You get the result the write would have had, and nothing is saved.

Shell
curl "https://api.bizisy.com/v1/org/units.create?dry_run=true" \
  -H "Authorization: Bearer $BIZISY_API_KEY" -H "Content-Type: application/json" \
  -d '{"name": "Platform", "kind": "team"}'
JSON
{
  "data": { "id": "01k6…", "name": "Platform", "kind": "team", "parent_id": "u1", "head": null, "archived": false, "member_count": 0 },
  "dry_run": true,
  "events": [{ "type": "org.unit.created.v1", "payload": { "unit_id": "01k6…" } }],
  "summary": "Created unit Platform"
}
  • data: what the call would return. Ids of records it would create are real-looking but don't exist.
  • events: the internal events the change would emit (the source of webhooks).
  • summary: the line it would write to Activity.

A failing dry run fails exactly like the real call would, with the same error.

What a dry run never does#

  • Save anything: the whole change runs in a transaction that is rolled back.
  • Send email (invites, notices), deliver webhooks, start checklists or issue secrets (a webhook endpoint's dry run never creates a signing secret).
  • Count against an Idempotency-Key: dry runs ignore the header.

Dry runs do count against your rate limit.

Through MCP#

Every write tool takes dry_run: true. The servers tell assistants to preview every change, show it to the person and only then commit (Previews and approvals through AI). Unlike REST previews, MCP previews are recorded in Activity with the status dry_run, so you can see what an assistant proposed.

When to use one#

  • Before a bulk change (org.setup.apply, org.people.import_csv): the preview lists every warning and every row error, and nothing is written until you're happy.
  • In a form or a wizard: preview on "Review", commit on "Confirm".
  • To check that a key may do something, without doing it.

Something missing or wrong on this page? Write to hello@bizisy.com.

Developer docs