workflow_definition

prepare_workflow_definition

Generic Workflow Builder lifecycle step 1: after the user has confirmed any reusable workflow definition, save it as a disabled prepared workflow, run a real dry run using dry_run_inputs, and return proof for user review. Do not call this before the user has confirmed the reusable definition. After this succeeds, show the dry-run output and ask the user to authorize it with authorize_prepared_workflow.

post/prepare_workflow_definition

Request

  • Base URL: https://app.podmule.com/api/v1
  • URL: https://app.podmule.com/api/v1/prepare_workflow_definition
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Stripe-style idempotency key. When present, repeat invocations within 24h with the same body return the original response; same key + different body returns 409 IDEMPOTENCY_KEY_REUSED.

X-PodMule-Dry-Run'true' | 'false'

When set to "true", routes the call to the capability's dryRun() method — same scope/precondition checks fire as the real handler, but persistence is skipped. The audit row is tagged result_status=dry_run.

Request body

unknown required

Response

Capability output wrapped in { data }.

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.