Create Embedded Service Deployment
sf_create_embedded_serviceCreate Embedded Service deployments that bundle chat buttons or messaging channels into embeddable web snippets for websites or Experience Cloud sites.
Instructions
Creates an Embedded Service deployment (EmbeddedServiceConfig) that bundles a chat button or messaging channel into a web snippet for embedding on websites or Experience Cloud sites.
channelType: Chat (uses a LiveChatButton) or Messaging (uses a MessagingChannel) chatButtonName: required for Chat type — the LiveChatButton API name messagingChannelName: required for Messaging type — the MessagingChannel API name site: the Experience Cloud site or Salesforce Site API name to associate with
Branding:
primaryColor: main brand color (hex, e.g. "#0070D2")
secondaryColor: secondary/header color
fontName: web font name (e.g. "Salesforce Sans")
After creation, get the deployment code snippet from Setup → Embedded Service Deployments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | Yes | Experience Cloud site name or 'none' for non-community deployment | |
| label | Yes | ||
| fontName | No | Font family name, e.g. 'Salesforce Sans' | |
| channelType | No | LiveAgent | |
| description | No | ||
| serviceName | No | Alias for deploymentName | |
| primaryColor | No | Primary brand color hex, e.g. '#0070D2' | |
| chatButtonName | No | LiveChatButton API name (for LiveAgent) | |
| deploymentName | No | API name of the Embedded Service deployment | |
| secondaryColor | No | Secondary color hex | |
| messagingChannelName | No | MessagingChannel API name (for MessagingChannel) |