REST Message legacy workflow activity

  • Release version: Xanadu
  • Updated August 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of REST Message legacy workflow activity

    The REST Message legacy workflow activity allows administrators to override REST endpoints or supply variables for REST Message module functions (POST, PUT, GET, DELETE). It is deprecated as of the Xanadu release and is no longer available for new workflow development. Existing workflows using this activity will continue to work but require re-activation to edit. New workflows should use the Orchestration REST Activity templates instead.

    Show full answer Show less

    Key Features

    • REST Message and Function Selection: Specify the REST Message and the HTTP method function (put, post, get, delete) to execute.
    • Endpoint Override: Optionally override the REST endpoint defined in the function record.
    • Variable Substitution: Supply variables to substitute in outbound REST messages, using a defined name=value format with escaping for special characters.
    • MID Server Support: Optionally use a MID Server to send the REST message, useful for accessing endpoints behind firewalls or subnetworks. You can select a specific MID Server or let the workflow find one automatically based on IP range and capability.
    • Response Handling Script: Execute a custom script after receiving the response, with access to the full response body via the activity.output variable.

    Practical Implications for ServiceNow Customers

    This legacy activity enables integration with external REST endpoints by executing HTTP methods with flexible endpoint and variable control. However, it is deprecated, so for new workflows, customers should adopt the Orchestration REST Activity templates which provide updated and supported functionality. Existing workflows using this activity remain functional but require re-activation to modify.

    Using a MID Server is important when the REST endpoint is inaccessible directly from the ServiceNow instance, ensuring secure and reliable connectivity within network boundaries.

    The scripting capability after the REST call allows customers to handle responses programmatically, enabling advanced processing or integration logic within workflows.

    The legacy REST Message activity enables an administrator to override the REST endpoint or supply the variables configured in the REST Message module.

    This activity is deprecated in the Xanadu release and no longer shows up in the Workflow canvas for new workflow development. New workflows should use the Orchestration REST Activity templates instead.

    Existing workflows using it will continue to work as designed. To edit this activity in an existing workflow, you must re-activate the activity.

    The REST Message activity executes a dead link REST function (POST, PUT, GET, or DELETE) on an endpoint using values defined in the function record.

    Note:
    If you want to use a MID Server to send the REST message, the MID Server must be accessible by the instance and configured to use SSH.

    Input variables

    Table 1. REST Message activity input variables
    Field Description
    Rest Message
    REST Message Name of the Create a REST message to run. This is a reference field to the REST Message [sys_rest_message] table (System Web Services > Outbound > REST Message).
    REST Message Function Function to call that is defined in a REST message function. This is a reference field to the HTTP Method [sys_rest_message_fn] table (System Web Services > Outbound > REST Message).

    Available functions are put, post, get, or delete. You can edit functions in the HTTP Methods related list in each REST Message record.
    REST Endpoint REST endpoint to use instead of the Endpoint defined in the HTTP Method record. Leave this field blank to use the defined endpoint in the REST Message Function record.
    Rest Message Variables
    Variables Values to use for Variable substitution in outbound REST messages defined in the HTTP Method record.
    Use the following format for the string: 
    name1=value1, name2=value2, . . .
    For example, use name=${nameValue}, id=${idValue} where name and id are function variables. If either the variable name or value contains a comma or equal sign, escape those characters with a backslash.
    Rest Message MID Server
    Use MID Server Check this box if you want to use a MID Server to send the REST message. A MID Server might be necessary to reach an endpoint within a firewall or a subnetwork that is not visible from the instance. If this check box is selected, but no MID Server is defined in the MID Server field, the workflow automatically attempts to find a MID Server based on IP range and the REST capability.
    MID Server Name of the MID Server to use. This field is available when Use MID Server is selected. The workflow ignores this parameter if the use_midserver parameter is disabled.
    Rest Message Script
    Sensor Script The script to execute after the request has been made and a response has been received. You can access the full response body from the activity.output variable.