forcedotcom/sf-skills / plugins/builder/service-engagement/skills/service-digital-engagement-deployment-configure
service-digital-engagement-deployment-configure
VerifiedConfigures Embedded Messaging Deployments for Messaging for In-App and Web (MIAW). Use when the user needs to create a new embedded messaging deployment from scratch using Connect API with defaults, or update an existing deployment's settings using Metadata API. Produces Connect API request payloads for new deployments and EmbeddedServiceConfig metadata XML for updates. TRIGGER when the user mentions embedded messaging deployment, embedded service deployment, MIAW deployment, messaging widget setup, chat widget configuration, embedded chat deployment, or references a .EmbeddedServiceConfig-meta.xml file. DO NOT TRIGGER when the user is creating a messaging channel (use service-digital-engagement-channel-configure), configuring legacy Live Agent embedded service, or generating the JavaScript code snippet for website embedding.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 17.0 KB |
| assets/esd_api_mobile_template.xml | config | 1.4 KB |
| assets/esd_web_update_template.xml | config | 5.7 KB |
| examples/esd_api.xml | config | 1.4 KB |
| examples/esd_mobile.xml | config | 1.4 KB |
| examples/esd_web_full.xml | config | 1.5 KB |
| examples/esd_web_prechat_fields.xml | config | 3.3 KB |
| references/branding_and_tooling.md | markdown | 3.9 KB |
| references/code_snippet.md | markdown | 2.8 KB |
| references/connect_api_creation.md | markdown | 5.1 KB |
| references/deployment_settings.md | markdown | 7.3 KB |
| references/onboarding_contract.md | markdown | 9.1 KB |
| references/prechat_forms.md | markdown | 21.7 KB |
| scripts/check-api-version.shexecutable | script | 1.6 KB |
references/deployment_settings.md
View on GitHub# Embedded Messaging Deployment Settings Reference
Complete reference for all configurable settings on an `EmbeddedServiceConfig` metadata type.
---
## Deployment Types
| Type | Value | Use Case | Creation Method |
|------|-------|----------|-----------------|
| API | `API` | Headless integrations, no UI widget | Metadata API or Connect API |
| Mobile | `Mobile` | Native mobile app messaging | Metadata API or Connect API |
| Web | `Web` | Browser-based chat widget | Connect API (create), Metadata API (update) |
---
## Top-Level Fields
| Field | Type | Required | Default | Description |
|-------|------|----------|---------|-------------|
| `masterLabel` | String | Yes | — | Deployment display name |
| `deploymentType` | Enum | Yes | — | `API`, `Mobile`, or `Web` |
| `deploymentFeature` | String | Yes | `EmbeddedMessaging` | Always `EmbeddedMessaging` |
| `clientVersion` | Enum | Yes | - | only applicable to Web deployment type. `WebV1`, `WebV2` |
| `areGuestUsersAllowed` | Boolean | Yes | `false` | Allow unauthenticated guest access |
| `isEnabled` | Boolean | Yes | `true` | Whether deployment is active |
| `shouldHideAuthDialog` | Boolean | Yes | `false` | Hide auth dialog from users |
| `site` | String | Web only | — | Experience Site name (format: `ESW_<name>_<timestamp>`) |
| `branding` | String | Web only | — | Reference to a `BrandingSet` name (Web deployments only) |
| `isTermsAndConditionsEnabled` | Boolean | No | `false` | Show T&C acceptance in pre-chat |
| `isTermsAndConditionsRequired` | Boolean | No | `false` | Require T&C acceptance before chatting |
---
## Embedded Service Messaging Channel (`<embeddedServiceMessagingChannel>`)
Links the deployment to a messaging channel and configures widget behavior. All boolean fields below are **required** in the XML.
| Field | Type | Default | Description |
|-------|------|---------|-------------|
| `messagingChannel` | String | — | **Required.** Channel `channelPlatformKey` |
| `businessHours` | String | — | BusinessHours `businessHoursName` |
| `displayNameFormat` | String | — | Display name shown when pre-chat is enabled. **Exactly 3 brace tokens** (empty for unused, e.g. `{_firstName}{_lastName}{}`); each token = a pre-chat field's `externalParameterName`, **not** its `formField`. See `references/prechat_forms.md` → displayNameFormat Rules |
| `formula` | String | — | Condition logic expression referencing `sequence` numbers from `<embdMsgChannelInvitationConditions>` (e.g., `1 AND 2`, `1 OR 2 OR 3`). Required when `isInvitationEnabled` is `true`. Must be updated whenever conditions are added or removed |
| `isChatInvitationCustomizable` | Boolean | `false` | **Required.** Allow customizing chat invitation. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `isEnabled` | Boolean | `true` | **Required.** Whether messaging is enabled on this deployment |
| `isInvitationEnabled` | Boolean | `false` | **Required.** Enable proactive chat invitations. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `isSendInvtAllowedAfterAccept` | Boolean | `false` | **Required.** Allow invitations after previous one accepted. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `isSendInvtAllowedAfterReject` | Boolean | `false` | **Required.** Allow invitations after previous one rejected. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `shouldShowAgentforceTagline` | Boolean | `false` | **Required.** Show Agentforce branding tagline. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `shouldShowDeliveryReceipts` | Boolean | `false` | **Required.** Show message delivery receipts. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `shouldShowEmojiSelection` | Boolean | `false` | **Required.** Enable emoji picker. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `shouldShowReadReceipts` | Boolean | `false` | **Required.** Show read receipts. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `shouldShowTypingIndicators` | Boolean | `false` | **Required.** Show typing indicators. Can only be `true` for Web deployments; must be `false` for API/Mobile |
| `shouldStartNewLineOnEnter` | Boolean | `false` | **Required.** Enter key creates new line instead of sending. Can only be `true` for Web deployments; must be `false` for API/Mobile |
---
## Pre-Chat Forms (`<embeddedServiceForms>`) and `displayNameFormat`
Pre-chat is OFF by default. Form and field structure, hidden fields, the channel coupling and Omni-Flow routing prerequisites, ChoiceList (dropdown) fields, deactivating vs. removing fields, `displayNameFormat` rules, and pre-chat gotchas are all in `references/prechat_forms.md`.
---
## Branding
Referenced as a top-level `<branding>` field with the BrandingSet name.
```xml
<branding>My_BrandingSet</branding>
```
**Important**: A BrandingSet with defaults is auto-created by the Connect API when the deployment is created. To override specific properties (colors, fonts, dimensions), use the Tooling API — see `references/branding_and_tooling.md`.
---
### Invitation Condition Rules (`<embdMsgChannelInvitationConditions>`)
Available since API v58.0. Repeatable. Configures conditions under which the messaging widget proactively invites a visitor to chat. Applicable to Web deployments only.
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `sequence` | Integer | Yes | Position in `conditionLogic` expression (1-based) |
| `conditionType` | Enum | Yes | The type of condition to evaluate (e.g., `SecondsOnPage`, `SecondsOnSite`, `NumberOfPageViews`, `UrlMatch`, `CustomVariable`) |
| `operand` | Enum | Yes | Comparison operator (`Equals`, `NotEqual`, `Contains`, `NotContain`, `GreaterThan`, `LessThan`, `LessOrEqual`, `GreaterOrEqual`, `StartWith`) |
| `customVariableName` | String | No | Custom variable name (when `conditionType` references a CustomVariable) |
| `value` | String | Yes | The value to compare against |
### Example
```xml
<embdMsgChannelInvitationConditions>
<sequence>1</sequence>
<conditionType>UrlMatch</conditionType>
<operand>Contains</operand>
<value>/support</value>
</embdMsgChannelInvitationConditions>
<embdMsgChannelInvitationConditions>
<sequence>2</sequence>
<conditionType>SecondsOnPage</conditionType>
<operand>GreaterThan</operand>
<value>30</value>
</embdMsgChannelInvitationConditions>
```
---
## API Method Summary
| Operation | Metadata API | Tooling API | Connect API |
|-----------|-------------|-------------|-------------|
| Create any ESD (Web) | No | No | Yes |
| Create any ESD (API/Mobile) | Yes | No | Yes |
| Update ESD (top-level + channel settings) | Yes | Yes | No |
| Update ESD (forms/labels) | Yes | No | No |
| Create BrandingSet | No (auto-created by Connect API) | No | Yes |
| Update BrandingSet properties | No | Yes | No |
| Publish ESD | No | No | Yes |
---
## Less Common Gotchas
| Issue | Resolution |
|-------|------------|
| `embeddedServiceFlowConfig.enabled` error | Set to `false` unless you specifically need embedded flows (not routing flows) |
| reCAPTCHA configuration rejected | reCAPTCHA is `@HideInWsdl` — must use Tooling API |
| Business hours not taking effect | Only updating existing business hours works; creation is managed separately |
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy. | Stars: 119k | Updated | Claude CodeCodex | Verified | Install |
| childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release. | Stars: 118k | Updated | Claude CodeCodex | Verified | Install |