curl --request POST \
--url https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run \
--header 'Content-Type: application/json' \
--data '
{
"incidentId": "<string>",
"incidentTitle": "<string>",
"playbooks": [
{
"id": "<string>",
"sequence": 123,
"entityId": "<string>",
"parameters": {}
}
],
"incidentNumber": 123,
"isQueued": true
}
'import requests
url = "https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run"
payload = {
"incidentId": "<string>",
"incidentTitle": "<string>",
"playbooks": [
{
"id": "<string>",
"sequence": 123,
"entityId": "<string>",
"parameters": {}
}
],
"incidentNumber": 123,
"isQueued": True
}
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({
incidentId: '<string>',
incidentTitle: '<string>',
playbooks: [{id: '<string>', sequence: 123, entityId: '<string>', parameters: {}}],
incidentNumber: 123,
isQueued: true
})
};
fetch('https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run', 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/api/v2/workspaces/{workspaceId}/gamebooks/run",
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([
'incidentId' => '<string>',
'incidentTitle' => '<string>',
'playbooks' => [
[
'id' => '<string>',
'sequence' => 123,
'entityId' => '<string>',
'parameters' => [
]
]
],
'incidentNumber' => 123,
'isQueued' => true
]),
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/api/v2/workspaces/{workspaceId}/gamebooks/run"
payload := strings.NewReader("{\n \"incidentId\": \"<string>\",\n \"incidentTitle\": \"<string>\",\n \"playbooks\": [\n {\n \"id\": \"<string>\",\n \"sequence\": 123,\n \"entityId\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"incidentNumber\": 123,\n \"isQueued\": true\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/api/v2/workspaces/{workspaceId}/gamebooks/run")
.header("Content-Type", "application/json")
.body("{\n \"incidentId\": \"<string>\",\n \"incidentTitle\": \"<string>\",\n \"playbooks\": [\n {\n \"id\": \"<string>\",\n \"sequence\": 123,\n \"entityId\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"incidentNumber\": 123,\n \"isQueued\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run")
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 \"incidentId\": \"<string>\",\n \"incidentTitle\": \"<string>\",\n \"playbooks\": [\n {\n \"id\": \"<string>\",\n \"sequence\": 123,\n \"entityId\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"incidentNumber\": 123,\n \"isQueued\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"status": "Pending",
"isQueued": true
},
"meta": {
"requestId": "<string>",
"timestamp": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}Run a gamebook
Requires gamebooks:execute and access to the route workspace. Service accounts may submit new gamebooks only: only documented inputs are accepted; portal approval, retry, and internal state fields are rejected. Playbook sequence values must contain exactly 1..N without duplicates or gaps. Workspace policies and partner approval settings apply. A 200 response with isQueued=true and status=Pending means the plan awaits portal approval; it has not executed. Use gamebooks:read to poll history. Service accounts cannot approve, retry, deny, or cancel gamebooks.
curl --request POST \
--url https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run \
--header 'Content-Type: application/json' \
--data '
{
"incidentId": "<string>",
"incidentTitle": "<string>",
"playbooks": [
{
"id": "<string>",
"sequence": 123,
"entityId": "<string>",
"parameters": {}
}
],
"incidentNumber": 123,
"isQueued": true
}
'import requests
url = "https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run"
payload = {
"incidentId": "<string>",
"incidentTitle": "<string>",
"playbooks": [
{
"id": "<string>",
"sequence": 123,
"entityId": "<string>",
"parameters": {}
}
],
"incidentNumber": 123,
"isQueued": True
}
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({
incidentId: '<string>',
incidentTitle: '<string>',
playbooks: [{id: '<string>', sequence: 123, entityId: '<string>', parameters: {}}],
incidentNumber: 123,
isQueued: true
})
};
fetch('https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run', 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/api/v2/workspaces/{workspaceId}/gamebooks/run",
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([
'incidentId' => '<string>',
'incidentTitle' => '<string>',
'playbooks' => [
[
'id' => '<string>',
'sequence' => 123,
'entityId' => '<string>',
'parameters' => [
]
]
],
'incidentNumber' => 123,
'isQueued' => true
]),
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/api/v2/workspaces/{workspaceId}/gamebooks/run"
payload := strings.NewReader("{\n \"incidentId\": \"<string>\",\n \"incidentTitle\": \"<string>\",\n \"playbooks\": [\n {\n \"id\": \"<string>\",\n \"sequence\": 123,\n \"entityId\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"incidentNumber\": 123,\n \"isQueued\": true\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/api/v2/workspaces/{workspaceId}/gamebooks/run")
.header("Content-Type", "application/json")
.body("{\n \"incidentId\": \"<string>\",\n \"incidentTitle\": \"<string>\",\n \"playbooks\": [\n {\n \"id\": \"<string>\",\n \"sequence\": 123,\n \"entityId\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"incidentNumber\": 123,\n \"isQueued\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/workspaces/{workspaceId}/gamebooks/run")
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 \"incidentId\": \"<string>\",\n \"incidentTitle\": \"<string>\",\n \"playbooks\": [\n {\n \"id\": \"<string>\",\n \"sequence\": 123,\n \"entityId\": \"<string>\",\n \"parameters\": {}\n }\n ],\n \"incidentNumber\": 123,\n \"isQueued\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"status": "Pending",
"isQueued": true
},
"meta": {
"requestId": "<string>",
"timestamp": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}Path Parameters
Body
Public v2 inputs for a new gamebook submission, without portal approval or executor state.
Incident identifier in the authorized route workspace.
Required non-empty incident display title.
Detection source of the incident.
Sentinel, DefenderXDR, QRadar, Splunk, CrowdStrike, SentinelOne, SumoLogic Actions with unique, contiguous sequence values from 1 through the number of actions.
Show child attributes
Show child attributes
Optional incident display number.
Requests human approval. False never overrides server-side approval requirements.