service-digital-engagement-channel-configure
Configures and deploys enhanced chat Messaging Channels for Messaging for In-App and Web (MIAW). Use when the user needs to create, deploy, and activate a messaging channel configured with Omni-Channel Flow, Omni-Channel Queue, User, or Agentforce Service Agent routing. Generates MessagingChannel me
By forcedotcom · 2,351 installs
npx skills add forcedotcom/sf-skills --skill service-digital-engagement-channel-configure
Source repository · Upstream listing
Configuring Enhanced Chat Channel
Creates MessagingChannel metadata XML for Salesforce Messaging for In App and Web (MIAW). This skill produces a fully configured enhanced chat channel with routing, user verification, pre chat, and automated response settings ready for Metadata API deployment.
Scope
In scope : Creating MessagingChannel metadata with Omni Channel Flow routing, Omni Channel Queue routing, or Agentforce Service Agent (ASA) routing; enabling User Verification; configuring all channel settings (pre chat forms, automated responses, consent keywords, file attachments, custom parameters)
Out of scope : Creating the referenced Omni Channel Flow/Queue definitions (use automation flow generate ), creating the Embedded Service Deployment (separate metadata type — use service digital engagement deployment configure ), creating permission sets for messaging (use platform permission set generate ), configuring the Embedded Service Code Snippet
Clarifying Questions
Before generating, ask the user if not already clear:
What is the channel name / label? (used for masterLabel and file name)
What routing type? (Omni Channel Flow, Omni Channel Queue, User, or Agentforce Service Agent)
What is the routing target? (Flow API name, Queue developer name, User ID, or ASA bot name)
For Flow, User, or ASA routing: What is the fallback queue name?
Should User Verification be enabled? (defaults to true per this skill)
Are there pre chat form fields required? If so, which fields and types?
Required Inputs
Gather or infer before proceeding:
Channel name : Used for masterLabel and the file name ( <Name .messagingChannel meta.xml )
Routing type : One of Queue , Flow , User , or AgentforceServiceAgent
Routing target : The developer name of the queue, flow, user, or ASA bot
Fallback queue (Flow, User, and ASA): The developer name of the fallback queue for escalation
User verification : Whether to require JWT based identity verification (default: true )
Defaults unless specified:
messagingChannelType : EmbeddedMessaging
authMode : Auth
chatAbandonmentTimeout : 5 (minutes)
endUserIdleTimeOut : 5 (minutes)
isAttachmentUploadEnabled : true
maxFileSize : 5 (MB)
allowedFileTypes : bmp,csv,doc,docx,gif,jpg,pdf,png,tiff,txt,xls,xml
anonymousUserJwtExpirationTime : 360 (minutes, required for UnAuth, range 60 4320)
verifiedUserJwtExpirationTime : 60 (minutes, required for Auth, range 60 240)
isAbandonedChatsEnabled : false
isSaveTranscriptEnabled : false
isFallbackMessageEnabled : false
isEstimatedWaitTimeEnabled : false
isFileAttachmentExtUnrestricted : false
isQueuePositionEnabled : false
isSynchronousChatEnabled : false
isVoiceModeEnabled : false
Workflow
All steps are sequential. Do not skip or reorder.
Phase 1 — Gather Context
1. Verify org API version — run scripts/check api version.sh 67.0 <org alias and report any errors it returns. If the script fails, generate a sfdx project.json in the metadata output folder with "sourceApiVersion": "67.0" .
2. Collect inputs — confirm the channel label, routing type, routing target, and verification settings from the user per Clarifying Questions above.
3. Determine file name — run scripts/normalize channel name.sh "<LABEL " and surface any errors it returns.
4. Verify routing target exists — query the org to confirm the referenced routing target exists:
For Queue: sf data query query "SELECT Id, DeveloperName FROM Group WHERE Type='Queue' AND DeveloperName='<QUEUE NAME '" target org <org alias
For Flow: sf data query query "SELECT Id, ApiName FROM FlowDefinitionView WHERE ApiName='<FLOW NAME ' AND IsActive=true" target org <org alias
For User: sf data query query "SELECT Id, Username FROM User WHERE Id='<USER ID ' AND IsActive=true" target org <org alias
For ASA: sf data query query "SELECT Id, DeveloperName FROM BotDefinition WHERE DeveloperName='<BOT NAME '" target org <org alias
Also verify the fallback queue exists (required for Flow, User, and ASA routing)
If any target is not found, inform the user and ask whether to create it. If the user confirms:
For Queue: generate a .queue meta.xml with MessagingSession as the queueSobject type and deploy it before the channel. A new queue is unusable for routing without a QueueRoutingConfig — a channel deployed against a queue with none fails at session start with "Agents are not available. Try again later," even though the channel itself deploys and activates cleanly. Immediately after the queue deploys, resolve or create its routing config by following service agentforce channel configure 's references/queue resolution.md Step 4 — do not defer this to a later skill invocation, since this may be the only place a newly created queue is ever touched.
For Flow/User/ASA: inform the user that the flow, user, or bot must be created separately (out of scope for this skill)
5. Read the channel settings reference — load references/channel settings.md to understand all available configuration options and their valid values.
Phase 2 — Generate Metadata
6. Read the metadata template — load assets/messaging channel template.xml as the starting structure.
7. Apply routing configuration — set sessionHandlerType and the corresponding handler field:
Routing Type sessionHandlerType Required Fields
Omni Channel Queue Queue sessionHandlerQueue
Omni Channel Flow Flow sessionHandlerFlow + sessionHandlerQueue (fallback)
User User sessionHandlerUser + sessionHandlerQueue (fallback)
Agentforce Service Agent AgentforceServiceAgent sessionHandlerQueue (fallback) + sessionHandlerAsa (bot dev name — required, see v67 note below)
v67 note — <sessionHandlerAsa is required in the XML, not rejected. Confirmed on a v67.0 org: omitting <sessionHandlerAsa causes the deploy to fail with "Missing required Agentforce Service Agent." Include it and the deploy binds SessionHandlerId automatically — no post deploy Data API PATCH needed.
1. Verify the bot is Active before channel creation. The Metadata API rejects binding with "Only active Agentforce Service Agents are supported." Run sf agent activate o <org api name <BotDevName and confirm BotVersion.Status = Active first.
2. Deploy the XML with <sessionHandlerType AgentforceServiceAgent</sessionHandlerType , <sessionHandlerQueue (fallback), and <sessionHandlerAsa {BotDevName}</sessionHandlerAsa .
3. Verify: sf data query o <org q "SELECT SessionHandlerId, FallbackQueueId FROM MessagingChannel WHERE DeveloperName='<ChannelDevName '" json — both must be non null after the deploy, with no separate PATCH step.
8. Apply user verification — if enabled, set embeddedConfig.authMode to Auth and include <messagingAuthorizations . If not enabled, set embeddedConfig.authMode to UnAuth and omit <messagingAuthorizations .
9. Configure embedded settings — populate <embeddedConfig with:
allowedFileTypes — comma separated file extensions (no spaces)
anonymousUserJwtExpirationTime — JWT expiration in minutes (required for UnAuth)
verifiedUserJwtExpirationTime — JWT expiration in minutes (required for Auth)
chatAbandonmentTimeout — minutes before abandoned conversation cleanup
isAbandonedChatsEnabled — enable abandoned chat detection
isAttachmentUploadEnabled — file upload support
isEstimatedWaitTimeEnabled — show estimated wait time
isFallbackMessageEnabled — fallback when agents unavailable
isFileAttachmentExtUnrestricted — allow any file extension
isSaveTranscriptEnabled — save conversation transcripts
maxFileSize — maximum attachment size in MB
10. Configure messaging keywords — generate <messagingKeywords elements:
OptOut type with individual <keyword elements: cancel, end, quit, stop, stopall, unsubscribe
Help type with <keyword : help
11. Apply standard parameters — if the user needs standard pre chat fields, generate <standardParameters elements with parameterType . If the channel uses Flow based routing and the user specifies flow variable mappings, include <actionParameterMappings with actionParameterName to map each parameter to a flow input variable.
12. Apply custom parameters — if the user needs pre chat data collection, generate <customParameters elements with name , masterLabel , parameterDataType , externalParameterName , and maxLength . If the channel uses Flow based routing and the user specifies flow variable mappings, include <actionParameterMappings with actionParameterName to map each parameter to a flow input variable.
13. Generate the file — produce the .messagingChannel meta.xml file following the template structure. Place at the path the user specifies, or default to the project's metadata source path under messagingChannels/ .
Phase 3 — Deploy and Activate
14. Deploy the channel — deploy the generated .messagingChannel meta.xml file to the target org:
15a. ASA routing only — verify the bind landed. Skip this step for Queue, Flow, and User routing types. Because <sessionHandlerAsa was included in the deployed XML (step 7), the deploy itself binds SessionHandlerId — no separate Data API PATCH is needed.
Both SessionHandlerId and FallbackQueueId must be non null. If either is null, confirm <sessionHandlerAsa and <sessionHandlerQueue were both present in the deployed XML and that the bot was Active before the deploy.
15. Activate the channel — after successful deployment, activate the messaging channel:
Phase 4 — Validate
16. Verify against checklist — confirm all items in the Verification Checklist below pass before presenting output.
17. Present output — show the generated file to the user with a summary of configured settings and confirm activation status. Offer next steps:
Automated responses — ask if the user wants to configure <automatedResponses (OptOutConfirmation, HelpResponse). If yes, generate elements with autoResponseContentType: TextResponse , language , and XML escaped response text, then redeploy.
Rules / Constraints
Constraint Rationale
File name serves as the channel API name No channelPlatformKey field in the XML body
sessionHandlerType must match the handler fields present Setting Queue but populating sessionHandlerFlow causes deployment error
Flow routing requires both sessionHandlerFlow and sessionHandlerQueue Queue is the mandatory fallback for human escalation
User routing requires both sessionHandlerUser and sessionHandlerQueue Queue is the mandatory fallback when user is unavailable
ASA routing: include both sessionHandlerQueue and sessionHandlerAsa in the XML sessionHandlerAsa is required at v67 — the deploy fails with "Missing required Agentforce Service Agent" if omitted; the deploy itself binds SessionHandlerId , no PATCH needed
Bot must be Active before the metadata deploy that binds SessionHandlerId API rejects with "Only active Agentforce Service Agents are supported" if the bot is inactive
masterLabel max 40 characters Platform limit on channel labels
File name must match ^[a zA Z][a zA Z0 9 ] $ API name format enforced by Metadata API
allowedFileTypes is a comma separated string with no spaces Not a nested list or array
keyword elements are individual — one per trigger word Not a comma separated list
customParameters need name , masterLabel , parameterDataType , and externalParameterName Incomplete parameters fail silently
File extension is .messagingChannel meta.xml Metadata API uses this specific extension