Launch a feature in Engagement Messenger using URL parameters

  • Release version: Australia
  • Updated March 12, 2026
  • 1 minute to read

    • Use URL parameters in your website's URL to enable the deep linking and launch a feature in Engagement Messenger integrated with your website.

    Before you begin

    Configure Engagement Messenger.

    Embed Engagement Messenger in your web application.

    Role required: ec_admin and website administrator

    About this task

    You can use URL parameters to display specific feature in Engagement Messenger. When the URL is accessed, it opens your website and automatically loads the specified feature in Engagement Messenger. For example, you can embed the URL in an email to share a knowledge article from Engagement Messenger.
    Note:

    If you are using existing Embed code, ensure that you update the script to include v=3.1. For example:

    Engagement Messenger with the version number highlighted in the Embed code.

    Procedure

    1. Navigate to Engagement Messenger > Modules.
    2. In the Configure Engagement Messenger Module, open the Implement tab.
    3. Copy the code from the Embed code section.
    4. In a text editor, open the HTML file of the web page on your website where you integrate Engagement Messenger.
    5. Paste the code you copied before the closing body tag.
    6. Save the file.
    7. Modify the website URL to include the feature. 
      https://website/page.html?feature=<FEATURE_NAME>&<PARAM_NAME1>=<PARAM_VALUE1>&<PARAM_NAME2>=<PARAM_VALUE2>
      <FEATURE_NAME>
      The feature name. For information, see Feature context parameters supported in Engagement Messenger.
      <param_name1>=<param_value1>
      Name and value of a parameter associated with the feature. To define multiple parameters, use the same format. For more information, see Feature context parameters supported in Engagement Messenger.
    8. Optional: Verify that the URL launches the designated feature automatically.

    Result

    The feature you included in the URL is set as the default launch screen in Engagement Messenger.

    Example

    The following sample URL includes a system identifier (sys_id) for a knowledge article that will automatically display when the website is launched.

    https://mywebsite/page.html?feature=VIEW_ARTICLE &sys_kb_id=ec7617461b01f01080df6247b04bcbaf