Resume a waiting flow execution

Resumes a flow execution that is in waiting state

POST /flow_executions/{execution_id}/resume

Resume a waiting flow execution

cURL

curl --request POST \
  --url https://app.kapso.ai/api/v1/flow_executions/{execution_id}/resume \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "input": "yes",
  "message": {
    "button_id": "confirm_button",
    "additional_data": {
      "timestamp": "2024-01-15T10:30:00Z"
    }
  }
}
'

import requests

url = "https://app.kapso.ai/api/v1/flow_executions/{execution_id}/resume"

payload = {
    "input": "yes",
    "message": {
        "button_id": "confirm_button",
        "additional_data": { "timestamp": "2024-01-15T10:30:00Z" }
    }
}
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({
    input: 'yes',
    message: {
      button_id: 'confirm_button',
      additional_data: {timestamp: '2024-01-15T10:30:00Z'}
    }
  })
};

fetch('https://app.kapso.ai/api/v1/flow_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://app.kapso.ai/api/v1/flow_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([
    'input' => 'yes',
    'message' => [
        'button_id' => 'confirm_button',
        'additional_data' => [
                'timestamp' => '2024-01-15T10:30:00Z'
        ]
    ]
  ]),
  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://app.kapso.ai/api/v1/flow_executions/{execution_id}/resume"

	payload := strings.NewReader("{\n  \"input\": \"yes\",\n  \"message\": {\n    \"button_id\": \"confirm_button\",\n    \"additional_data\": {\n      \"timestamp\": \"2024-01-15T10:30:00Z\"\n    }\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://app.kapso.ai/api/v1/flow_executions/{execution_id}/resume")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": \"yes\",\n  \"message\": {\n    \"button_id\": \"confirm_button\",\n    \"additional_data\": {\n      \"timestamp\": \"2024-01-15T10:30:00Z\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.kapso.ai/api/v1/flow_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  \"input\": \"yes\",\n  \"message\": {\n    \"button_id\": \"confirm_button\",\n    \"additional_data\": {\n      \"timestamp\": \"2024-01-15T10:30:00Z\"\n    }\n  }\n}"

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

200

{
  "data": {
    "id": "exec-456def",
    "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "running",
    "started_at": "2023-11-07T05:31:56Z",
    "ended_at": "2023-11-07T05:31:56Z",
    "last_event_at": "2023-11-07T05:31:56Z",
    "tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "current_step": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Send Welcome Message",
      "step_type": "message"
    },
    "execution_context": {},
    "variables": {},
    "flow": {
      "id": "flow-123abc",
      "name": "Customer Onboarding Flow",
      "description": "Automated flow for onboarding new customers",
      "status": "active",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "last_executed_at": "2023-11-07T05:31:56Z",
      "execution_count": 42
    }
  }
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Resource not found",
  "status": 404,
  "message": "The requested resource could not be found"
}

{
  "error": "Execution cannot be resumed",
  "message": "The execution is not in a waiting state"
}

Authorizations

X-API-Key · string · header · required

API key required for all endpoints

Path Parameters

execution_id · string<uuid> · required

Body

application/json

input · string

Text input to resume the flow with

Example:

"yes"

message · object

Structured message data to resume with

Example:

{
  "button_id": "confirm_button",
  "additional_data": { "timestamp": "2024-01-15T10:30:00Z" }
}

Response

200

application/json

Flow execution resumed successfully

data · object

Show child attributes