Splunk® SOAR (Cloud)

Build Playbooks with the Playbook Editor

Acrobat logo Download manual as PDF

The classic playbook editor will be deprecated soon. Convert your classic playbooks to modern mode.
After the future removal of the classic playbook editor, your existing classic playbooks will continue to run, However, you will no longer be able to visualize or modify existing classic playbooks.
For details, see:
Acrobat logo Download topic as PDF

Require user input using the Prompt block in your playbook

Use a Prompt block in your playbook to send a message to a user or group that they must acknowledge, either to continue running a playbook or to enter required information.

To configure a prompt, perform the following tasks:

  1. Drag and drop the half-circle icon attached to any existing block in the editor. Select a Prompt block from the menu that appears.
  2. Select a User or Role from the drop-down list to approve the prompt. If the task is assigned to a group of users, the first user to approve it kickstarts the playbook run. Consider selecting one of these dynamic roles:
    • Event owner: to prompt the user or role the container is assigned to when the playbook is run.
    • Playbook run owner: to prompt the user who initiated the playbook. If a playbook run is initiated by automation, the prompt block fails and no prompt is sent.
  3. In the Message box, craft a meaningful message so the users receiving the prompt understand what actions they must take.
  4. (Optional) Click + Message Parameter to search for and add the datapath to a message parameter. Adding a message parameter creates an input with a paired parameter that displays in the Message box. For details on specifying datapaths, see Specify data in your playbook.
  5. Click + Question and enter a question to ask the approver in the Question 1 box. Click + Question to add additional questions.
  6. From the Responses drop-down list, choose the type of response to the question that is required to complete the task.
  7. From the Required response time field, choose the response time in minutes.
  8. Click Done.

To learn more about how to format a Prompt message, see Customize the format of your playbook content.

You can also configure Advanced settings for a prompt block. Use the Delimiter box to specify an alternate separator to use when joining parameters that result in a list together. The default separator is ",". Use the Drop None checkbox to select whether or not you want to drop the "None" values from the resulting lists of parameters. By default, the "None" values are included. For more information on other Advanced settings, see Advanced settings.

Additionally, you can click the Info tab to create a custom name for the block, add a description for the block, and add a tooltip to the block. See Use custom names.

Last modified on 27 March, 2024
Customize the format of your playbook content
Determine your playbook flow in

This documentation applies to the following versions of Splunk® SOAR (Cloud): current

Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters