Submit Human Input Form

Submit the recipient’s response to a paused Human Input form. The workflow resumes on acceptance; use Stream Workflow Events to follow subsequent events. Requires WebApp delivery.

POST /form/human_input/{form_token}

Submit Human Input Form

cURL

curl --request POST \
  --url https://{api_base_url}/form/human_input/{form_token} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": {
    "comment": "Looks good to ship"
  },
  "action": "approve",
  "user": "abc-123"
}
'

200

success

{}

Authorizations

Authorization · string · header · required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

form_token · string · required

Access token for the paused form, returned in the human_input_required event from Run Workflow in streaming mode.

Body

application/json

inputs · object · required

Recipient-supplied values keyed by input output_variable_name.

action · string · required

ID of the action button the recipient selected. Must match one of the id values from the form's user_actions list (returned by Get Human Input Form).

Maximum string length: 20

Pattern: ^[A-Za-z_][A-Za-z0-9_]*$

user · string · required

End-user identifier for the submitter.

Response

200

application/json

Form submitted successfully. The response body is an empty object.

The response is of type object.