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/code_snippet.md
View on GitHub# Embedded Messaging Code Snippet
After a deployment is created and published, provide the customer with the appropriate code snippet for their deployment type.
---
## Web Deployment — JavaScript Snippet
For Web deployments, embed this JavaScript snippet on the customer's website.
```html
<script type='text/javascript'>
function initEmbeddedMessaging() {
try {
embeddedservice_bootstrap.settings.language = 'en_US';
embeddedservice_bootstrap.init(
'<ORG_ID>',
'<EMBEDDED_SERVICE_CONFIG_DEVELOPER_NAME>',
'<SITE_URL>',
{
scrt2URL: '<SCRT2_URL>'
}
);
} catch (err) {
console.error('Error loading Embedded Messaging: ', err);
}
};
</script>
<script type='text/javascript' src='<SITE_URL>/assets/js/bootstrap.min.js' onload='initEmbeddedMessaging()'></script>
```
### Web Parameters
| Parameter | Description | How to obtain |
|-----------|-------------|---------------|
| `SITE_URL` | The Experience Site base URL | From the deployment's `site` field — format: `https://<domain>/ESW_<name>_<timestamp>` |
| `ORG_ID` | The Salesforce Org ID (15-char) | `sf org display --target-org <org-alias> --json` → `result.id` |
| `EMBEDDED_SERVICE_CONFIG_DEVELOPER_NAME` | The deployment's developer name | Same as the `name` / API name used during creation |
| `SCRT2_URL` | The Service Cloud Real Time messaging endpoint | Format: `https://<instance>.salesforce-scrt.com` — obtain from Setup > Embedded Service Deployments |
### Placement
- Place the snippet in the `<body>` of every page where the widget should appear
- For Single Page Applications (SPAs), call `init()` once after the initial page load
---
## API/Mobile Deployment — Configuration JSON
For API and Mobile deployments, provide this configuration JSON for the native app integration.
```json
{
"OrganizationId": "<ORG_ID>",
"DeveloperName": "<EMBEDDED_SERVICE_CONFIG_DEVELOPER_NAME>",
"Url": "<SCRT2_URL>"
}
```
### API/Mobile Parameters
| Parameter | Description | How to obtain |
|-----------|-------------|---------------|
| `ORG_ID` | The Salesforce Org ID (15-char) | `sf org display --target-org <org-alias> --json` → `result.id` |
| `EMBEDDED_SERVICE_CONFIG_DEVELOPER_NAME` | The deployment's developer name | Same as the `name` / API name used during creation |
| `SCRT2_URL` | The Service Cloud Real Time messaging endpoint | Format: `https://<instance>.salesforce-scrt.com` — obtain from Setup > Embedded Service Deployments |
---
## Notes
- The deployment must be **published** before the snippet/config will function
- Web deployments use the JavaScript bootstrap snippet
- API/Mobile deployments use the JSON configuration for native SDK initialization
- If the customer changes the site URL or republishes, the snippet values remain the same unless the deployment is recreated
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 |