RunPlaybook
curl --request POST \
--url https://app.textql.com/v1/playbooks/run \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"playbookId": "<string>",
"dryRun": true,
"templateId": "<string>"
}
'import requests
url = "https://app.textql.com/v1/playbooks/run"
payload = {
"playbookId": "<string>",
"dryRun": True,
"templateId": "<string>"
}
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({playbookId: '<string>', dryRun: true, templateId: '<string>'})
};
fetch('https://app.textql.com/v1/playbooks/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://app.textql.com/v1/playbooks/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([
'playbookId' => '<string>',
'dryRun' => true,
'templateId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Connect-Protocol-Version: <connect-protocol-version>",
"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://app.textql.com/v1/playbooks/run"
payload := strings.NewReader("{\n \"playbookId\": \"<string>\",\n \"dryRun\": true,\n \"templateId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("Authorization", "Bearer <token>")
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.textql.com/v1/playbooks/run")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"playbookId\": \"<string>\",\n \"dryRun\": true,\n \"templateId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/v1/playbooks/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"playbookId\": \"<string>\",\n \"dryRun\": true,\n \"templateId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"chatId": "<string>",
"report": {
"subject": "<string>",
"summary": "<string>",
"blocks": [
{
"card": {
"blocks": "<array>"
}
}
],
"htmlPreview": "<string>",
"chatId": "<string>",
"reportId": "<string>"
},
"assets": [
{
"target": "<string>",
"previewType": "<string>",
"name": "<string>",
"url": "<string>",
"content": "<string>",
"error": "<string>"
}
]
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Playbooks
Run Playbook
Execute a playbook and return the generated report
POST
/
v1
/
playbooks
/
run
RunPlaybook
curl --request POST \
--url https://app.textql.com/v1/playbooks/run \
--header 'Authorization: Bearer <token>' \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--data '
{
"playbookId": "<string>",
"dryRun": true,
"templateId": "<string>"
}
'import requests
url = "https://app.textql.com/v1/playbooks/run"
payload = {
"playbookId": "<string>",
"dryRun": True,
"templateId": "<string>"
}
headers = {
"Connect-Protocol-Version": "<connect-protocol-version>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({playbookId: '<string>', dryRun: true, templateId: '<string>'})
};
fetch('https://app.textql.com/v1/playbooks/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://app.textql.com/v1/playbooks/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([
'playbookId' => '<string>',
'dryRun' => true,
'templateId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Connect-Protocol-Version: <connect-protocol-version>",
"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://app.textql.com/v1/playbooks/run"
payload := strings.NewReader("{\n \"playbookId\": \"<string>\",\n \"dryRun\": true,\n \"templateId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("Authorization", "Bearer <token>")
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.textql.com/v1/playbooks/run")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"playbookId\": \"<string>\",\n \"dryRun\": true,\n \"templateId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/v1/playbooks/run")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"playbookId\": \"<string>\",\n \"dryRun\": true,\n \"templateId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"chatId": "<string>",
"report": {
"subject": "<string>",
"summary": "<string>",
"blocks": [
{
"card": {
"blocks": "<array>"
}
}
],
"htmlPreview": "<string>",
"chatId": "<string>",
"reportId": "<string>"
},
"assets": [
{
"target": "<string>",
"previewType": "<string>",
"name": "<string>",
"url": "<string>",
"content": "<string>",
"error": "<string>"
}
]
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}v2 available: See POST /v2/playbooks//run for the REST-native version of this endpoint.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Define the version of the Connect protocol
Available options:
1 Define the timeout, in ms
⌘I