Workflows

Resume waiting workflow execution

Resume a workflow execution that is in ‘waiting’ status. Workflows enter waiting status when they reach a wait_for_response step or are explicitly paused.

Send a message with:

kind: Message type, defaults to “payload” if omitted
data: The actual payload - can be a string for simple text responses (e.g., “yes”, “no”) or an object for structured data (e.g., button clicks, form submissions)

Optionally include variables to update the execution context:

variables: Key-value pairs to merge into the execution context. These will be available in subsequent workflow steps as {{var_name}}. Existing variables with the same key will be overwritten.

After resuming, the workflow will continue processing from the waiting step with the provided message data and updated variables.

Call workflow routing: If the execution is waiting at a call workflow step, the input is routed to the child execution it started, following the chain down to the deepest waiting execution. Keep sending resumes to the original execution ID; the response reports where the input landed in id, echoes the requested ID in requested_execution_id, and includes parent_flow_execution_id.

Response: Returns minimal execution data (id, status, tracking_id, timestamps, workflow, current_step) plus the routing fields. Does not include execution_context or events. Use GET /workflow_executions/ to retrieve full execution details.

POST

workflow_executions

{execution_id}

resume

Resume waiting workflow execution

curl --request POST \
  --url https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "message": {
    "data": "yes, proceed",
    "kind": "payload"
  },
  "variables": {
    "estado": "retomado",
    "custom_var": 123,
    "user_response": "confirmed"
  }
}
'

import requests

url = "https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume"

payload = {
    "message": {
        "data": "yes, proceed",
        "kind": "payload"
    },
    "variables": {
        "estado": "retomado",
        "custom_var": 123,
        "user_response": "confirmed"
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    message: {data: 'yes, proceed', kind: 'payload'},
    variables: {estado: 'retomado', custom_var: 123, user_response: 'confirmed'}
  })
};

fetch('https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => [
        'data' => 'yes, proceed',
        'kind' => 'payload'
    ],
    'variables' => [
        'estado' => 'retomado',
        'custom_var' => 123,
        'user_response' => 'confirmed'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume"

	payload := strings.NewReader("{\n  \"message\": {\n    \"data\": \"yes, proceed\",\n    \"kind\": \"payload\"\n  },\n  \"variables\": {\n    \"estado\": \"retomado\",\n    \"custom_var\": 123,\n    \"user_response\": \"confirmed\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": {\n    \"data\": \"yes, proceed\",\n    \"kind\": \"payload\"\n  },\n  \"variables\": {\n    \"estado\": \"retomado\",\n    \"custom_var\": 123,\n    \"user_response\": \"confirmed\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": {\n    \"data\": \"yes, proceed\",\n    \"kind\": \"payload\"\n  },\n  \"variables\": {\n    \"estado\": \"retomado\",\n    \"custom_var\": 123,\n    \"user_response\": \"confirmed\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "running",
    "started_at": "2023-11-07T05:31:56Z",
    "last_event_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "whatsapp_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "<string>"
    },
    "current_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "<string>",
      "stepable_type": "<string>",
      "position": {
        "x": 123,
        "y": 123
      }
    },
    "requested_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

X-API-Key

string

header

required

Path Parameters

execution_id

string<uuid>

required

Execution identifier

Body

application/json

Request to resume a workflow execution that is in 'waiting' status. Executions wait when they reach a wait_for_response step or when explicitly paused. The message data can be a simple string for text responses or a structured object for complex interactions.

You can optionally include variables to update the execution context with new or modified variables that will be available to subsequent workflow steps.

message

object

required

Show child attributes

variables

object

Optional variables to merge into the execution context. These variables will be added to the vars section of the execution context, making them available throughout the workflow. New variables are merged with existing ones - duplicate keys will be overwritten with new values.

Example:

{
  "estado": "retomado",
  "custom_var": 123,
  "user_response": "confirmed"
}

Response

Execution resumed successfully

Response of the resume endpoint. data describes the execution that actually received the input, which is not always the execution in the request path.

data

object

required

Minimal execution representation for list endpoints

Show child attributes

Resume waiting workflow execution

curl --request POST \
  --url https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "message": {
    "data": "yes, proceed",
    "kind": "payload"
  },
  "variables": {
    "estado": "retomado",
    "custom_var": 123,
    "user_response": "confirmed"
  }
}
'

import requests

url = "https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume"

payload = {
    "message": {
        "data": "yes, proceed",
        "kind": "payload"
    },
    "variables": {
        "estado": "retomado",
        "custom_var": 123,
        "user_response": "confirmed"
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    message: {data: 'yes, proceed', kind: 'payload'},
    variables: {estado: 'retomado', custom_var: 123, user_response: 'confirmed'}
  })
};

fetch('https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => [
        'data' => 'yes, proceed',
        'kind' => 'payload'
    ],
    'variables' => [
        'estado' => 'retomado',
        'custom_var' => 123,
        'user_response' => 'confirmed'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume"

	payload := strings.NewReader("{\n  \"message\": {\n    \"data\": \"yes, proceed\",\n    \"kind\": \"payload\"\n  },\n  \"variables\": {\n    \"estado\": \"retomado\",\n    \"custom_var\": 123,\n    \"user_response\": \"confirmed\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": {\n    \"data\": \"yes, proceed\",\n    \"kind\": \"payload\"\n  },\n  \"variables\": {\n    \"estado\": \"retomado\",\n    \"custom_var\": 123,\n    \"user_response\": \"confirmed\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/platform/v1/workflow_executions/{execution_id}/resume")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": {\n    \"data\": \"yes, proceed\",\n    \"kind\": \"payload\"\n  },\n  \"variables\": {\n    \"estado\": \"retomado\",\n    \"custom_var\": 123,\n    \"user_response\": \"confirmed\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "running",
    "started_at": "2023-11-07T05:31:56Z",
    "last_event_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "whatsapp_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workflow": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "<string>"
    },
    "current_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "identifier": "<string>",
      "stepable_type": "<string>",
      "position": {
        "x": 123,
        "y": 123
      }
    },
    "requested_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_flow_execution_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Overview

WhatsApp API

Platform API

Workflows API

Kapso Agent API

Resume waiting workflow execution

Authorizations

Path Parameters

Body

Response