Playbooks Overview

playbooks are a series of triggers, logic, and actions that automate a workflow a playbook can contain triggers, actions, native actions, components, assets, inputs, and outputs to create or change flows with natural language, use playbook building mode (text to playbook) see create and modify playbooks with hero ai docid\ tmmnjglc0e9lipo37kzpb or the hero ai docid\ swz8uetvmvoojwgm xnk overview playbook architecture a playbook can have one or more flows each flow has exactly one trigger flows do not communicate with each other playbook data model on the canvas, turbine stores playbook information in two layers understanding both layers explains what save updates and why some changes appear only after you save from the canvas editor layer what you see in the ui what is stored what runs playbook (container) playbook name, description, canvas layout, flow order, annotations a builder playbook record that lists which flows belong to this playbook does not run by itself; groups flows flow one trigger and its actions on the canvas a playbook (flow) document automation definition plus yaml source ( meta src ) this is what executes when the flow is triggered how the two layers relate one playbook (container) can reference one or more flows each flow is a separate automation document linked from the container when you add a new flow on the canvas, the product creates a new flow document and adds its id to the container what happens when you save saving from the canvas editor can update both layers flow changes (triggers, actions, conditions, connections) the editor updates the in memory flow definition, merges it into the flow yaml source , and sends updates to the turbine playbook api for each dirty flow container changes (playbook name, description, flow order, annotations) the editor saves the builder playbook record separately, including the ordered list of flow ids if you change only flow logic and the container name does not change, you are still saving flow documents if you rename the playbook or reorder flows, the container save runs as well standalone playbooks from the playbook listing page when you create a playbook from orchestration > playbooks and open the classic playbook editor, you usually work with a single flow stored as one playbook document that path does not use a separate builder playbook container in the same way as a multi flow canvas playbook for creating playbooks, see how to create a playbook docid 0 kvg5p4lthw75itmpuwp (manual) or create and modify playbooks with hero ai docid\ tmmnjglc0e9lipo37kzpb (text to playbook) playbook listing page the playbook listing page provides a centralized view of all playbooks in your environment from this page, you can search for playbooks, apply filters to narrow the results, review playbook details, and perform common management actions navigate to orchestration > playbooks to access the playbook listing page search playbooks use the search bar in the upper right corner of the page to quickly locate playbooks you can search by playbook name playbook description the playbook list updates to display matching results as you type filter playbooks use the filters at the top of the page to narrow the list of playbooks created the created filter displays playbooks based on when they were created select one of the available relative time ranges, including last 15 minutes last 30 minutes last 1 hour last 5 hours last 10 hours last 24 hours today yesterday last 2 days last 3 days last 7 days this week last week this month last month this year you can also select custom range to specify a start date and end date after selecting a range, click apply to update the list created by the created by filter displays playbooks created by specific users you can search for a user by name select one or more users select all to display playbooks created by every user the playbook list updates after your selection last updated the last updated filter works the same way as the created filter filter playbooks based on when they were last modified by selecting a predefined relative time range or a custom date range, then click apply last updated by the last updated by filter works the same way as the created by filter search for one or more users and select them to display playbooks last updated by those users last run use the last run filter to display playbooks based on when they were most recently executed select a predefined relative time range or choose custom range , then click apply sort playbooks click the last updated column heading to sort the playbook list by the date the playbooks were last modified click the column heading again to reverse the sort order playbook list columns the playbook listing page displays the following information for each playbook column description name displays the playbook name below the name, the number of enabled flows is shown in the format enabled flows/total flows (for example, 5/12 flows enabled ) created date the playbook was created created by user who created the playbook last updated date the playbook was last modified last updated by user who last modified the playbook last run date the playbook was last executed playbook actions each playbook includes a more options (⋮) menu that provides additional management actions action description export export the playbook publish publish the playbook submit to swimlane submit the playbook to swimlane delete permanently delete the playbook by default, all filters are set to all , and the page displays all playbooks that you have permission to view you can apply multiple filters at the same time and use search with filters the search bar searches only the playbook name and description to reset a filter, select all from the corresponding filter dropdown playbook canvas basics the canvas is where you build playbooks using drag and drop actions, triggers, and reusable components it supports ai assistance, flow controls, and testing from the same workspace canvas layout add panel (left) browse and add triggers, actions, and components canvas (center) arrange actions and connect flows details panel (right) configure the selected trigger or action add panel use the add panel to search and drag items into the canvas triggers #native actions #record actions #components # flow connectors and direction flows use connectors to control execution between actions on success on failure on complete green connectors indicate success paths, while red connectors indicate failure paths the canvas uses a top down layout, so flows move from upstream (near the trigger) to downstream (later actions) for details, see flows docid\ tc21dpikhwkgvvvvaxbmq playbook details panel the right hand panel shows playbook details such as the name and description close the panel (x) to free up more canvas space test console use the test console to run end to end tests of your playbook flows for details, see test console # timeouts and limits canvas playbooks do not enforce a fixed maximum number of actions run timeouts, action timeouts, loop nesting, and data size limits apply during design and execution for the full reference, see timeouts and limits #