Skip to main content
POST
/
v2
/
playbooks
Create Playbook
curl --request POST \
  --url https://app.textql.com/v2/playbooks \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "prompt": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "connector_ids": [
    123
  ],
  "cron_string": "<string>",
  "email_addresses": [
    "<string>"
  ],
  "slack_channel_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key or JWT token

Response

Created playbook

​
id
string<uuid>
​
name
string
​
prompt
string
​
status
enum<string>
Available options:
draft,
deployed
​
created_at
string<date-time>
​
updated_at
string<date-time>
​
connector_ids
integer<int32>[]

Connector IDs attached to this playbook

​
cron_string
string

Cron schedule expression. Omitted when not set.

​
email_addresses
string[]

Email addresses for report delivery. Omitted when empty.

​
slack_channel_id
string

Slack channel for report delivery. Omitted when not set.