Update Event Raw Data

This command can only be executed in the "On Event Ingestion" trigger within an event playbook. Adds or updates the raw data of an event.

Reader Note

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

Implementation	Python
Command Category	System Utility
Tags	TRIGGER DATA EVENT EVENT MANAGEMENT

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Source Type	Optional	NOT AVAILABLE	`Trigger Output Data`
JSON Object	Optional	Fields to be added in Trigger Output Data "Data" section	JSON `{ "sampleKey": "sampleValue" }`

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

{
    "Data": {
        "sampleKey": "sampleValue"
    }
}

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/updateEventRawData

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 Object": {
      "sampleKey": <Sample Value here>
    }
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`String`	Required	The username of your D3 SOAR account.
Site	`String`	Required	The D3 SOAR site to run the remote command.
Source Type	`Number`	Optional	NOT AVAILABLE
JSON Object	`JSON Object`	Optional	Fields to be added in Trigger Output Data "Data" section

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Source Type": "Trigger Output Data",
    "JSON Object": {
      "sampleKey": "sampleValue"
    }
  }
}

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.

Sample Response

JSON

{
    "error": "",
    "returnData": {
        "Data": {
            "sampleKey": "sampleValue"
        }
    }
}