Skip to navigation

Create a playbook definition

View as Markdown

Creates a new organization-level playbook definition; it starts in draft status. Authorization: organization administrators only — other callers are rejected with 403. Body: name (required, 1-200 chars); optional description (<=5000 chars); optional spaceTypes (array of space-type slugs the playbook applies to — omit/empty means all space types); optional tasks (<=30 items, each { id (1-64), title (1-200), instructions?, dependsOn? (ids of tasks that must complete first) }); optional actions (<=20 items, each { installedActionId, preApproval?, postApproval?, dependsOn? (task ids only — an action may not depend on another action) } referencing installed actions, with per-action human-approval gates). Response 201: { data: Playbook }.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The playbook starts in draft.

namestringRequired1-200 characters
descriptionstringOptional<=5000 characters
spaceTypeslist of stringsOptional
taskslist of objectsOptional
modelstring or nullOptional<=200 characters
actionslist of objectsOptional

Response

The created playbook definition.
dataobject