Add Playbook to Incidents

LAST UPDATED: SEPT 11, 2024

Adds playbooks to incidents.

Implementation	System
Command Category	System Utility
Tags	INCIDENT

Inputs

Parameter Name	Required/Optional	Description	Sample Data
Incident Numbers	Required	The array of incident numbers, each corresponding to an incident to which the playbook will be added.	CODE `[20210202-26, 20210202-25]`
Playbook	Required	The name of playbook that is to be added to the incidents.	demoPlaybook
Additional Playbooks	Optional	The name of additional playbooks that are to be added to the incidents	CODE `[ "Simple Playbook Sample" ]`
Username	Required	The username of user who is adding the playbooks to the incidents. This username will be used only when the task is run automatically.	admin user

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

Successful

Context Data

The response data from the utility command.

SAMPLE DATA

JSON

[
    {
        "Incident Number": "20210202-26",
        "Playbook List": [
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "demoPlaybook",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    },
    {
        "Incident Number": "20210202-25",
        "Playbook List": [
            {
                "Playbook": "UpdateOwner",
                "User": "admin user"
            },
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "demoPlaybook",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    }
]

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

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": {
    "Incident Numbers": "<Incident Numbers here>",
    "Playbook": "<Playbook here>",
    "Additional Playbooks": "<Additional Playbooks here>",
    "Username": "<Username 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.
Incident Numbers	`array<string>`	Required	The array of incident numbers, each corresponding to an incident to which the playbook will be added.
Playbook	`string`	Required	The name of playbook that is to be added to the incidents.
Additional Playbooks	`array<string>`	Optional	The name of additional playbooks that are to be added to the incidents
Username	`string`	Optional	The username of user who is adding the playbooks to the incidents. This username will be used only when the task is run automatically.

Sample Request

SAMPLE DATA

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "Incident Numbers": "[20210202-26,20210202-25]",
    "Playbook": "demoPlaybook",
    "Additional Playbooks": [
      "Simple Playbook Sample"
    ],
    "Username": "admin user"
  }
}

Response

Response Fields

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

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": "[
    {
        "Incident Number": "20210202-26",
        "Playbook List": [
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "demoPlaybook",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    },
    {
        "Incident Number": "20210202-25",
        "Playbook List": [
            {
                "Playbook": "UpdateOwner",
                "User": "admin user"
            },
            {
                "Playbook": "Simple Playbook Sample",
                "User": "admin user"
            },
            {
                "Playbook": "demoPlaybook",
                "User": "admin user"
            }
        ],
        "Result": "Successful"
    }
  ]"
}