Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Feature context parameters supported in Engagement Messenger

Features for contextual launch capability enable you to set the default launch screen in Engagement Messenger.

FeatureEmbed codeFeature parameter description
CHAT
{ 
    feature: "CHAT", 
    params: { 
        "topic_id": "*<sys\_id>*",
        "language": "*<language\_name>*",
        ”sysparm_*<param\_name>*": "*<param\_value>*" 
    } 
}
  • <sys_id>

Identifies the Virtual Agent topic to be included in the chat.

  • <language_name>

Default chat language. For example, for French, specify fr

  • <param_name>:<param_value>

Any additional parameters to be passed to the Virtual Agent topic. The name of the parameter should start with sysparm. For example, sys_param_product_name.

WORK\_ORDER
{ 
    feature: "WORK_ORDER", 
    params: { 
        "table": "wm_order",
        "sys_id": "*&lt;sys\_id&gt;*"
        }
}
  • <sys_id>

System identifier (sys_id) of a work order.

CASE
{ 
    feature: "CASE", 
    params: { 
        "table": "sn_customerservice_case",
        "sys_id": "*&lt;sys\_id&gt;*"

    } 
}
  • <sys_id>

System identifier (sys_id) of a case.

NEW\_CASE
{ 
    feature: "NEW_CASE", 
    params: { 
        } 
}
None
CASE\_LIST
{ 
    feature: "CASE_LIST", 
    params: { 
        } 
}
None
VIEW\_ARTICLE
{ 
    feature: "VIEW_ARTICLE", 
    params: { 
        "sys_kb_id": "*&lt;sys\_id&gt;*"
    } 
}
  • <sys_id>

System identifier (sys_id) of a knowledge article.

SEARCH
{ 
    feature: "SEARCH", 
    params: { 
        "q": "*&lt;search\_term&gt;*"
    } 
}
  • <search_term>

Term to be searched for in a search results query.

CASE\_SEARCH
{ 
    feature: "CASE_SEARCH", 
    params: { 
        "q": "*&lt;search\_term&gt;*"
    } 
}
  • <search_term>

Term to be searched for in a case results query.

CATALOG\_ITEM
{ 
    feature: "CATALOG_ITEM", 
    params: { 
        "sys_id": "*&lt;sys\_id&gt;*"
    } 
}
  • <sys_id>

System identifier (sys_id) of a catalog item.

NEW\_APPOINTMENT
{ 
    feature: "NEW_APPOINTMENT", 
    params: { 
        } 
}
None
NEW\_WORK\_ORDER
{ 
    feature: "NEW_WORK_ORDER", 
    params: { 
        } 
}
None
HOME
{ 
    feature: "HOME", 
    params: { 
    } 
}
None

Related topics

Launch a feature in Engagement Messenger using custom code