Submit external input for a paused workflow execution

Base URL: https://{kibana_url}

POST /api/workflows/executions/{executionId}/steps/{stepId}/resume/external
POST /s/{space_id}/api/workflows/executions/{executionId}/steps/{stepId}/resume/external

Auth

Resume a workflow execution that is paused and waiting for external input. Submit input values as a JSON request body, authenticated with a token query parameter. Returns an HTML confirmation page.

Path parameters

space_id string optional: An identifier for the space. If space_id is not provided in the URL, the default space is used. Refer to Spaces for more information.
executionId string · max length: 128 required: Workflow execution ID
stepId string · max length: 128 required: Workflow step execution ID

Query parameters

token string · max length: 128 required: The resume token authenticating this request.

Request body

Type: object

Response

An HTML confirmation page confirming that the input was received and the workflow execution was resumed.

text/html

Response Type: string

Base URL: https://{kibana_url}

Examples

Request Console 1 / 2 languages

Console Kibana Dev Tools

POST kbn://api/workflows/executions/{executionId}/steps/{stepId}/resume/external?token={resumeToken}
Content-Type: application/json

{"severity":"high"}

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/executions/{executionId}/steps/{stepId}/resume/external?token=${RESUME_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"severity":"high"}'

Response

No example

Request Console 1 / 2 languages

Example external input payload for a waitForInput step

Console Kibana Dev Tools

POST kbn:/api/workflows/executions/EXECUTION_ID/steps/STEP_ID/resume/external
{
  "description": "Escalated from Slack triage",
  "severity": "high"
}

Generated from the API spec

curl Shell

curl \
  -X POST "${KIBANA_URL}/api/workflows/executions/${EXECUTION_ID}/steps/${STEP_ID}/resume/external" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Escalated from Slack triage",
    "severity": "high"
  }'

Generated from the API spec

Response

Success page confirming the input was received

<!DOCTYPE html><html><body><h1>Thank you</h1><p>Your response was received. You can close this window.</p></body></html>