Get Trigger Output Data With JSON Path

This command can only be executed within the "On Event Ingestion" trigger of an event playbook. It extracts Trigger Output Data utilizing a specified JSON Path.

Reader Note

Please note that this command is only applicable within an event Playbook.

Implementation	System
Command Category	System Utility
Tags	TRIGGER DATA

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Source Type	Optional	The data source from which data is obtained	`Event Trigger Data`
JSON Path	Required	JSON Path used to get a part from Trigger Data	`$.Data.Root`

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

SAMPLE DATA

JSON

{
    "result": {
        "success": true
    }
}

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

{
    "User": "Tom",
    "IPAddress": "13.64.156.22",
    "RiskLevel": "Medium"
}

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

CODE

https:/{base_url}/{api_namespace}/api/Command/GetTriggerOutputDataWithJSONPath

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": "<Username here>",
  "Site": "<Site here>",
  "CommandParams": {
    "Source Type": "<Source Type here>",
    "JSON Path": "<JSON Path here>"
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`Text`	Required	The username of your D3 SOAR account.
Site	`Text`	Required	The D3 SOAR site to run the remote command.
Source Type	`Number`	Optional	The data source from which data is obtained
JSON Path	`Text`	Required	JSON Path used to get a part from Trigger Data

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Source Type": "Event Trigger Data",
    "JSON Path": "$.Data.Root"
  }
}

Response

Response Fields

Field Name	Type	Description
error	`text`	The error message if the API request has failed.
returnData	`JSON Object`	The return data from the API request.
contextData	`JSON Object`	The context data from the API request.

Sample Response

JSON

{
    "error":"",
    "returnData":{
      "result": {
        "success": true
      }
     },
    "rawData":"",
    "contextData":{
        "User": "Tom",
        "IPAddress": "13.64.156.22",
        "RiskLevel": "Medium"
    }
}