Ferndesk

Create a playbook

Adds a playbook: a situation your team handles a set way, and the steps the AI agent follows in it. A new playbook is off unless enabled is true.

POST /v1/playbooks
Bearer token scope settings:write

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.

conditions any

What a conversation must pass for the agent to see it: { all: [...] } of { field, op, values, not? }. Fields: channel (email, chat, slack; chat is the widget and the help center), priority, tag (label ids), property ({ field: "property", key, op, values }, the customer's properties, verified customers only), customerGroup (customer group ids). Conditions on one field widen, different fields narrow, not hides. Null runs it on every conversation; left out keeps what it has.

Responses