Salesforce Docs Portal

MeetingPlaybookDefinition

Represents a meeting playbook definition that organizes stages, capabilities, and permission-set mappings for guided meeting workflows.

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

MeetingPlaybookDefinition components have the suffix .meetingPlaybookDefinition and are stored in the meetingPlaybookDefinitions folder.

Version

MeetingPlaybookDefinition components are available in API version 67.0 and later.

Fields

clonedFrom

  • Field Type: String
  • Description: The template used to clone the meeting playbook.

description

  • Field Type: String
  • Description: The description of the meeting playbook definition.

isActive

  • Field Type: Boolean
  • Description: Required. Indicates whether the meeting playbook definition is available for use true or not false.

label

  • Field Type: String
  • Description: Required. The label for the meeting playbook definition.

meetingPlaybookDefPermSet

  • Field Type: MeetingPlaybookDefPermSet
  • Description: Defines the permission-set mappings that control access to this playbook.

meetingPlaybookDefStage

MeetingPlaybookDefPermSet

meetingPlaybookDefinition

  • Field Type: String
  • Description: The structure and sequence of stages used to create meeting playbooks.

permissionSet

  • Field Type: String
  • Description: The permission set you need to be able to view this meeting definition.

MeetingPlaybookDefStage

actionPlanTmplPkgConfig

  • Field Type: String
  • Description: The template used to create the action plan.

mtgPlbkDefStgCapability

  • Field Type: MtgPlbkDefStgCapability
  • Description: List of capabilities available in this stage, including prompts, flows, and reference records.

stageOrder

  • Field Type: Int
  • Description: Required. The order of this meeting playbook definition stage.

stageType

  • Field Type: MeetingPlaybookStageType (enumeration of type string)
  • Description: Required. The type of stage.
  • Possible values:
    • PreMeeting
    • InSession
    • PostMeeting

MtgPlbkDefStgCapability

capabilityOrder

  • Field Type: Int
  • Description: Required. The order in which the actions show.

description

  • Field Type: String
  • Description: The description of the capability. If left blank, the description defaults to the one defined in the promptTemplateflow.

flow

  • Field Type: String
  • Description: The flow that implements the action. If this column is populated, the promptTemplate column must be null. This column contains the developerName for native Salesforce prompt templates, or the ID for customer-created or packaged templates.

isAllowMultipleUse

  • Field Type: Boolean
  • Description: Indicates whether you can apply or use the action multiple times true or not false.

masterLabel

  • Field Type: String
  • Description: The label for the meeting playbook definition stage capability. If left blank, the label defaults to the one defined in the promptTemplate or flow.

promptGeneratedTextType

  • Field Type: MeetingPlaybookStageTextType (enumeration of type string)
  • Description: Defines the text the prompt template generates for the meeting stage.
  • Possible values:
    • MeetingSummaryPrompt
    • AgendaPrompt
    • PreMeetingActionPrompt
    • MeetingTalkingPointsPrompt
    • FollowupSummaryPrompt
    • ClientSummary
    • MeetingPrepBrief
    • ClientEmailDraft
    • DocumentSummaryPrompt
    • AttendeesPrompt
    • VoiceRecordPrompt
    • TakeMeetingNotesPrompt
    • MeetingDiscussionGuide
    • PostMeetingActionPrompt
    • MeetingFollowup

promptTemplate

  • Field Type: String
  • Description: The prompt template that implements the action. If this column is populated, the flow column must be null. This column contains the developerName for native Salesforce prompt templates, or the ID for customer-created or packaged templates.

referenceRecord

  • Field Type: String
  • Description: The value of the Prompt Template or Flow field. Stored as a string, this can represent either the developerName of a standard Salesforce template or flow, or the ID of a custom or packaged one.

Declarative Metadata Sample Definition

The following is an example of a MeetingPlaybookDefinition component.

<?xml version="1.0" encoding="UTF-8"?>
<MeetingPlaybookDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
    <description>Guided workflow for customer quarterly business review meetings.</description>
    <isActive>true</isActive>
    <label>QBR Playbook</label>
    <meetingPlaybookDefPermSet>
        <meetingPlaybookDefinition>QBR_Playbook</meetingPlaybookDefinition>
        <permissionSet>Sales_Manager</permissionSet>
    </meetingPlaybookDefPermSet>
</MeetingPlaybookDefinition>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>*</members>
        <name>MeetingPlaybookDefinition</name>
    </types>
    <version>67.0</version>
</Package>