Submit external input for a paused workflow execution Generally available; added in 9.4.0

POST /api/workflows/executions/{executionId}/steps/{stepId}/resume/external
Api key auth Basic auth

Spaces method and path for this operation:

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

Refer to Spaces for more information.

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

  • executionId string Required

    Workflow execution ID

    Maximum length is 128.

  • stepId string Required

    Workflow step execution ID

    Maximum length is 128.

Query parameters

  • token string Required

    The resume token authenticating this request.

    Maximum length is 128.

application/json

Body

Responses

  • 200 text/html

    An HTML confirmation page confirming that the input was received and the workflow execution was resumed.
POST /api/workflows/executions/{executionId}/steps/{stepId}/resume/external 
curl \
  -X POST "${KIBANA_URL}/api/workflows/executions/{executionId}/steps/{stepId}/resume/external?token=${RESUME_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{"severity":"high"}'

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

{"severity":"high"}
Request example
Example external input payload for a waitForInput step 
{
  "description": "Escalated from Slack triage",
  "severity": "high"
}
Response examples (200)
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>