Tests
Recorded Flows
List, run, inspect, delete, or schedule recorded flows.
POST
/
test
/
flow
Recorded Flows
curl --request POST \
--url https://api.example.com/test/flow \
--header 'Content-Type: application/json' \
--data '
{
"action": "<string>",
"data": {
"flowId": "<string>",
"when": "<string>",
"time": "<string>"
}
}
'import requests
url = "https://api.example.com/test/flow"
payload = {
"action": "<string>",
"data": {
"flowId": "<string>",
"when": "<string>",
"time": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
action: '<string>',
data: {flowId: '<string>', when: '<string>', time: '<string>'}
})
};
fetch('https://api.example.com/test/flow', 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.example.com/test/flow",
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([
'action' => '<string>',
'data' => [
'flowId' => '<string>',
'when' => '<string>',
'time' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/test/flow"
payload := strings.NewReader("{\n \"action\": \"<string>\",\n \"data\": {\n \"flowId\": \"<string>\",\n \"when\": \"<string>\",\n \"time\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/test/flow")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"<string>\",\n \"data\": {\n \"flowId\": \"<string>\",\n \"when\": \"<string>\",\n \"time\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/test/flow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"<string>\",\n \"data\": {\n \"flowId\": \"<string>\",\n \"when\": \"<string>\",\n \"time\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"content": {},
"content.runId": "<string>"
}List, run, inspect, delete, or schedule recorded flows. Dispatch the desired operation with the
Returned for
Returned for
The replay queue could not accept the job. Retry with backoff.
action field in the request body.
Actions
| Action | Description |
|---|---|
list | List all saved flows for the authenticated user. |
run | Queue a flow replay. Returns 202 with a runId. |
runs | Retrieve past runs for a flow, including step results and analysis. |
delete | Delete a saved flow. |
schedule | Schedule a flow replay for later or on an interval. |
Request body
string
required
One of
list, run, runs, delete, or schedule.object
Responses
200 OK
Returned for list, runs, delete, and schedule.
boolean
required
string
required
One of
Flows loaded., Flow runs loaded., Flow deleted., or Flow replay scheduled.object
required
Payload matching the message. For example,
flows, runs, { ok: true }, or { transactionId, scheduledId, kind }.202 Accepted
Returned for run when the replay is queued.
string
required
503 Service Unavailable
The replay queue could not accept the job. Retry with backoff.
Successful responses include the
X-Credits-Remaining header.⌘I
Recorded Flows
curl --request POST \
--url https://api.example.com/test/flow \
--header 'Content-Type: application/json' \
--data '
{
"action": "<string>",
"data": {
"flowId": "<string>",
"when": "<string>",
"time": "<string>"
}
}
'import requests
url = "https://api.example.com/test/flow"
payload = {
"action": "<string>",
"data": {
"flowId": "<string>",
"when": "<string>",
"time": "<string>"
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
action: '<string>',
data: {flowId: '<string>', when: '<string>', time: '<string>'}
})
};
fetch('https://api.example.com/test/flow', 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.example.com/test/flow",
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([
'action' => '<string>',
'data' => [
'flowId' => '<string>',
'when' => '<string>',
'time' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/test/flow"
payload := strings.NewReader("{\n \"action\": \"<string>\",\n \"data\": {\n \"flowId\": \"<string>\",\n \"when\": \"<string>\",\n \"time\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/test/flow")
.header("Content-Type", "application/json")
.body("{\n \"action\": \"<string>\",\n \"data\": {\n \"flowId\": \"<string>\",\n \"when\": \"<string>\",\n \"time\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/test/flow")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"action\": \"<string>\",\n \"data\": {\n \"flowId\": \"<string>\",\n \"when\": \"<string>\",\n \"time\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>",
"content": {},
"content.runId": "<string>"
}