Skip to content

Test a workflow draft

POST
/v1/forms/{form}/workflow/test
curl --request POST \
  --url https://api.submeto.com/v1/forms/example/workflow/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "source": "example", "submission_id": "example", "fields": {} }'

Starts a no-delivery dry run against an immutable draft and input snapshot. Requires workflows:test; recent_submission also requires submissions:read. Clients must obtain explicit user confirmation before calling this operation.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
form
required
string

The form ID.

Header Parameters

Section titled “Header Parameters”
If-Match
string
Idempotency-Key
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
source
required

Input source: sample, manual, or recent_submission.

string
submission_id

Submission ID when source is recent_submission.

string
nullable
fields

Manual field values when source is manual.

object
Examplegenerated
{
  "source": "example",
  "submission_id": "example",
  "fields": {}
}

Responses

Section titled “Responses”

202

Section titled “202”

Workflow test started

Media typeapplication/json
object
data
object
run_id
string
status
string
reserved_compute_points
integer
deliveries_enabled
boolean
request_id
string
Example
{
  "data": {
    "run_id": "01JRUN00000000000000000000",
    "status": "pending",
    "reserved_compute_points": 2,
    "deliveries_enabled": false
  },
  "request_id": "REQUEST_ID"
}