Progress Indicators

Display a progress indicator when an AI agent is responding to a conversation. Progress indicators are useful to provide more information and context to users when an AI Agent is executing complex actions. This feature is available from CapabilitiesVersion 62.

Sample Payload

{
    "channelPlatformKey": "ec935ff5-8e16-4299-a9fd-88221a3e94f3",
    "channelType": "embedded_messaging",
    "channelAddressIdentifier": "ec935ff5-8e16-4299-a9fd-88221a3e94f3",
    "conversationId": "01c25401-3353-444e-8323-ace07e1b7375",
    "conversationEntry": {
        "senderDisplayName": "Agentforce Service Agent",
        "identifier": "a7ba79d6-6ee5-402c-936c-d2716682c4ed",
        "entryType": "ProgressIndicator",
        "entryPayload": "{\"entryType\":\"ProgressIndicator\",\"id\":\"a7ba79d6-6ee5-402c-936c-d2716682c4ed\",\"progressIndicator\":{\"indicatorType\":\"ProgressUpdateIndicator\",\"progressMessage\":{\"formatType\":\"Text\",\"text\":\"Calling agent action: SvcCopilotTmpl__GetAllCasesForContact\"}}}",
        "sender": {
            "role": "Chatbot",
            "appType": "chatbot",
            "subject": "0XxSB000000IgTp",
            "clientIdentifier": ""
        },
        "contextParamMap": {},
        "visibilityStrategy": "Default",
        "transcriptedTimestamp": 1731960237641,
        "relatedRecords": [],
        "clientTimestamp": 1731960237624,
        "clientDuration": 0
    }
}