{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"embeddedservicemessagingchannel",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "EmbeddedServiceConfig - Metadata API",
"description": "Represents a setup node for creating an Embedded Service for Web deployment. This type extends the Metadata metadata type and inherits its fullName field.",
"file_information": ".EmbeddedServiceConfig",
"directory_location": "EmbeddedServiceConfig",
"fields_columns": [
"type",
"description"
],
"fields": {
"areGuestUsersAllowed": {
"type": "boolean",
"description": "Specifies whether a user must be logged in to access an embedded component. Available in API version 45.0 and later."
},
"authMethod": {
"type": "EmbeddedServiceAuthMethod (enumeration of type string)",
"description": "Type of login method selected for this Embedded Service deployment. Valid values are: CommunitiesLogin–Customers log in using Communities. CustomLogin–Customers log in using your own custom authentication. Available in API version 43.0 and later."
},
"branding": {
"type": "string",
"description": "The branding set that has all of the branding configurations for this Embedded Service configuration. Available in API version 52.0 and later."
},
"customMinimizedComponent": {
"type": "string",
"description": "The custom Lightning component that’s used in this Embedded Service deployment in its minimized state. Available in API version 43.0 to 45.0."
},
"deploymentFeature": {
"type": "EmbeddedServiceDeploymentFeature(enumeration of type string)",
"description": "The conversation type of this Embedded Service deployment. Valid values are: EmbeddedMessaging—Messaging for In-App and Messaging for Web deployments Flows FieldService LiveAgent None Available in API version 52.0 and later."
},
"deploymentType": {
"type": "EmbeddedServiceDeploymentType (enumeration of type string)",
"description": "The platform this Embedded Service is deployed to. Valid values are: Mobile—For future use Web API Available in API version 51.0 and later."
},
"embeddedServiceAppointmentSettings": {
"type": "EmbeddedServiceAppointmentSettings[]",
"description": "The settings of the Embedded Service deployment whose deploymentFeature is FieldService. Available in API version 46.0 and later."
},
"embeddedServiceCustomComponents": {
"type": "EmbeddedServiceCustomComponent[]",
"description": "The custom components used in this Embedded Service deployment. Available in API version 44.0 and later."
},
"embeddedServiceCustomLabels": {
"type": "EmbeddedServiceCustomLabel[]",
"description": "The custom labels used in this Embedded Service deployment. Available in API version 44.0 and later."
},
"embeddedServiceCustomizations": {
"type": "EmbeddedServiceCustomization[]",
"description": "The customizations used in this Embedded Service deployment. Each customization is associated with a static resource. Available in API version 50.0 and later."
},
"embeddedServiceFlowConfig": {
"type": "EmbeddedServiceFlowConfig[]",
"description": "Represents a setup node for creating an embedded flow. Available in API version 45.0 and later."
},
"embeddedServiceFlows": {
"type": "EmbeddedServiceFlow[]",
"description": "All of the flows used by this Embedded Service deployment. Available in API version 45.0 and later."
},
"embeddedServiceLayouts": {
"type": "EmbeddedServiceLayout[]",
"description": "The layout of an Appointment Management deployment of an Embedded Service. Available in API version 44.0 and later."
},
"isEnabled": {
"type": "boolean",
"description": "Indicates if this Embedded Service deployment is enabled (true)."
},
"isTermsAndConditionsEnabled": {
"type": "boolean",
"description": "Indicates whether Terms and Conditions is displayed. Displaying Terms and Conditions is supported if the deploymentFeature is either EmbeddedMesssaging or LiveAgent. The default is false. Available in API version 59.0 and later."
},
"isTermsAndConditionsRequired": {
"type": "boolean",
"description": "Indicates whether acceptance of the Terms and Conditions is required before starting a chat. Displaying Terms and Conditions is supported if the deploymentFeature is either EmbeddedMesssaging or LiveAgent. The default is false. Available in API version 59.0 and later."
},
"masterLabel": {
"type": "string",
"description": "The name of the Embedded Service configuration node. Available in API version 37.0 and later.",
"required": true
},
"shouldHideAuthDialog": {
"type": "boolean",
"description": "Specifies whether the prompt that the customer log in again during a flow is hidden (true) or not (false). When it’s hidden, the customer is taken directly to your login page. This field is set to false by default. Available in API version 43.0 and later."
},
"site": {
"type": "string",
"description": "The name of the Experience site or website connected to this Embedded Service deployment. Available in API version 37.0 and later.",
"required": true
}
},
"embeddedservicemessagingchannel": {
"businessHours": {
"type": "String",
"description": "The Business Hours record that’s associated with this specific embedded service deployment."
},
"isEnabled": {
"type": "Boolean",
"description": "Indicates whether this embedded service deployment is enabled.",
"required": true
},
"messagingChannel": {
"type": "String",
"description": "The MessagingChannel record that’s associated with this specific embedded service deployment.",
"required": true
},
"shouldShowDeliveryReceipts": {
"type": "Boolean",
"description": "Indicates whether delivery receipts are shown in the UI.",
"required": true
},
"shouldShowEmojiSelection": {
"type": "Boolean",
"description": "Indicates whether emoji selection is shown in the UI.",
"required": true
},
"shouldShowReadReceipts": {
"type": "Boolean",
"description": "Indicates whether read reciepts are shown in the UI.",
"required": true
},
"shouldShowTypingIndicators": {
"type": "Boolean",
"description": "Indicates whether typing indicators are shown in the UI.",
"required": true
},
"shouldStartNewLineOnEnter": {
"type": "Boolean",
"description": "Indicates whether pressing Enter starts a new line of text in the UI.",
"required": true
}
},
"sub_types": {
"EmbeddedServiceAppointmentSettings": {
"appointmentConfirmImg": {
"type": "string",
"description": "The URL of the image to display when an appointment is confirmed."
},
"enabled": {
"type": "boolean",
"required": true,
"description": "Indicates whether this deployment is enabled. The default is false."
},
"homeImg": {
"type": "string",
"description": "The URL of the image to display on the appointment management widget home screen."
},
"logoImg": {
"type": "string",
"description": "The URL of the logo to display in the appointment management widget."
},
"shouldShowExistingAppointment": {
"type": "boolean",
"description": "Indicates whether existing appointments are displayed in the appointment management widget. The default is false."
},
"shouldShowNewAppointment": {
"type": "boolean",
"description": "Indicates whether new appointments are displayed in the appointment management widget. The default is false."
}
},
"EmbeddedServiceCustomComponent": {
"customComponent": {
"type": "string",
"description": "The name of the custom component."
},
"customComponentType": {
"type": "EmbeddedServiceCustomComponentType (enumeration of type string)",
"description": "The type of custom component. Valid values are: LA_Prechat (component for pre-chat in Embedded Chat) LA_Minimized (component for the minimized chat window) LA_PlainTextChatMessage (component for the text area in Embedded Chat) MIAW_Prechat(component for the prechat form in Messaging for In-App and Web) MIAW_Header(component for the header of the messaging conversation window in Messaging for In-App and Web) MIAW_TextMessage(component for the text message bubbles in a Messaging for In-App and Web conversation)"
}
},
"EmbeddedServiceCustomLabel": {
"customLabel": {
"type": "string",
"description": "The customized label that appears in the embedded component."
},
"feature": {
"type": "EmbeddedServiceFeature (enumeration of type string)",
"description": "The feature that this embedded component uses. Valid values are: Base ChannelMenu EmbeddedMessaging—Messaging for In-App and Messaging for Web deployments FieldService Flows LiveAgent NotInUse"
},
"labelKey": {
"type": "EmbeddedServiceLabelKey (enumeration of type string)",
"description": "The type of label for this embedded component. The value corresponds to the label within a label group (substate of chat state or page type)."
}
},
"EmbeddedServiceCustomization": {
"customizationName": {
"type": "string",
"description": "The name of the customization applied to the embedded service. This name can contain only underscores and alphanumeric characters and must be unique in an EmbeddedServiceConfig setup. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.",
"required": true
},
"description": {
"type": "string",
"description": "A description of the customization."
},
"embeddedServiceResources": {
"type": "EmbeddedServiceResource[]",
"description": "The reference to the static resource that contains the javascript file of the customization.",
"required": true
}
},
"EmbeddedServiceForm": {
"displayContext": {
"type": "EmbeddedServiceFormDisplayContext (enumeration of type string)",
"description": "Indicates when we display this form. Values are: Session- The pre-chat form is displayed every session. Conversation- Tthe pre-chat form is displayed every conversation. None- Don’t select this option.",
"required": true
},
"isActive": {
"type": "Boolean",
"description": "Indicates whether the form is active. The default value is false."
}
},
"EmbeddedServiceFormField": {
"formField": {
"type": "string or enum",
"description": "Maps to either a StandardMessingChannelParameter or a CustomMessagingChannelParameter",
"required": true
},
"messagingChannelParameterType": {
"type": "MessagingChannelParameterType (enumeration of type string) OR StandardMessagingChannelParameter (enumeration of type string)",
"description": "Indicates whether formField points to a StandardMessagingChannelParameter or a CustomMessagingChannelParameter. Please match the Enum value here to the formField passed in. Valid values for MessagingChannelParameterType are: Standard - select this field when you want to reference a StandardMessagingChannelParameter Custom - select this field when you want to reference a CustomMessagingChannelParameter Valid values for StandardMessagingChannelParameter are: FirstName LastName Email Subject",
"required": true
},
"formFieldType": {
"type": "EmbeddedServiceFormFieldType (enumeration of type string)",
"description": "Indicates the type of data is passed by the End User when filling out the Prechat form. Valid values are: Text Email Phone Number Checkbox Choicelist",
"required": true
},
"displayOrder": {
"type": "Integer",
"description": "Indicates the relative order of the form field in the prechat form. For Prechat fields where isHidden is set to true displayOrder must be set to -1. For Prechat fields where isHidden is set to false, this value must be greater than or equal to 0."
},
"isRequired": {
"type": "Boolean",
"description": "Indicates whether a Prechat form field is required. If isHidden is set to true, isRequired must be set to false."
},
"isHidden": {
"type": "Boolean",
"description": "Indicates whether a Prechat form field is displayed in the UI. isHidden can only be set to true if the formField field is set to CustomMessagingChannelParameter and messagingChannelParameterType is set to Custom."
},
"choiceList": {
"type": "ChoiceList",
"description": "The choice list that's associated with EmbeddedServiceFormField. ChoiceList can only be associated if the formField is set to CustomMessagingChannelParameter and messagingChannelParameterType is set to Custom."
},
"embeddedServiceCustomLabels": {
"type": "EmbeddedServiceCustomLabel[]",
"description": "The custom label for this field."
}
},
"EmbeddedServiceResource": {
"resource": {
"type": "string",
"description": "The ID of the static resource that contains the javascript file of the customization.",
"required": true
},
"resourceType": {
"type": "EmbeddedServiceResourceType (enumeration of type string)",
"description": "The embedded service feature to customize. Valid values are: ChatInvitation—Use for Chat deployments. SettingsFile—Use if you’re configuring a settings file for a Channel Menu deployment.",
"required": true
}
},
"EmbeddedServiceFlow": {
"flow": {
"type": "string",
"description": "The developer name of the flow."
},
"flowType": {
"type": "EmbeddedServiceFlowType(enumeration of type string)",
"description": "The type of flow. Valid values are: FS_CancelAppointment FS_Flow FS_ModifyAppointment FS_NewAppointment LA_Survey"
},
"isAuthenticationRequired": {
"type": "boolean",
"description": "Indicates whether users are required to log in to access the Embedded Service component. The value can’t be true for the FS_Flow value and must be true for all other values."
}
},
"EmbeddedServiceFlowConfig": {
"enabled": {
"type": "boolean",
"description": "Indicates whether the embedded flow is enabled."
}
},
"EmbeddedServiceLayout": {
"embeddedServiceLayoutRules": {
"type": "EmbeddedServiceLayoutRule[]",
"description": "The appointment statuses that the layout of the Embedded Service deployment is valid for."
},
"layout": {
"type": "string",
"description": "The FlexiPage that represents the layout of this Embedded Service deployment."
},
"layoutType": {
"type": "EmbeddedServiceLayoutType (enumeration of type string)",
"description": "The type of layout applied to the Embedded Service deployment. Values are: FS_AppointmentHome"
}
},
"EmbeddedServiceLayoutRule": {
"appointmentStatus": {
"type": "string",
"description": "The service appointment status that the EmbeddedServiceLayout subtype is valid for."
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n