Ferndesk

postPlaybooks

POST /v1/playbooks
Bearer token

Body

required application/json
id string

Playbook id (pb_...). Leave out to add one. An id this workspace does not have yet adds the playbook with that id, so a retry never makes two.

name string · min length: 1· max length: 120

Needed to add a playbook.

when string · max length: 300

The situation it covers, in plain words.

steps array of string · max items: 20

What the agent does, in order. Keep mention tokens such as @[custom.plan-lookup] as they are.

enabled boolean

Only enabled playbooks reach the agent. A new playbook is off unless this is true.

Responses