cURL
curl --request POST \ --url https://app.textql.com/v1/playbooks/run \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "playbookId": "<string>", "dryRun": true, "templateId": "<string>" } '
{ "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>" } ] }
Execute a playbook and return the generated report
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
UUID of the playbook to run
1
If true, executes the playbook without sending notifications (email/Slack)
UUID of the template data row to use. Not currently supported via the platform API.
Success
UUID of the chat created for this run
The generated report from the playbook execution
Show child attributes
Preview assets (charts, images, etc.) generated during execution