Codeless Playbooks for Webhook Data Formatting

LAST UPDATED: DEC 20, 2024

Introduction

This article provides guidance on implementing webhook data formatting for codeless playbooks. With a webhook data formatter, users can efficiently operate on incoming data streams and ensure proper formatting prior to downstream processing. By following the outlined steps, the user will accomplish the following: 1) Transform webhook data by transmitting it through a demonstration codeless playbook and 2) Use the transformed webhook data within the Webhook Authentication section of an integration Fetch Event command.

Creating a New Utility Command

1. Create a codeless playbook utility command.

   

   1. Click on the Configuration navigation link.

   2. Click on the Utility Commands module.

   3. Click on the + button next to the search field.

2. Set it up a a Code Playbook implementation.

   

   1. Enter a Command Display Name.

   2. Select the Codeless Playbook option under the Implementation label.

   3. Click on the + Add button.

Making the Codeless Playbook Available

1. Click on the Edit button to enter mode.

2. Click on the initial codeless playbook node.

3. Scroll down, then tick the Event/Incident Data Formatter checkbox to make this codeless playbook available for use in the Using the Codeless Playbook as Data Formatter section.

4. Click on the button.

5. Click on the Submit button to transition this codeless playbook into mode.

   

Adding Sample Inputs and Outputs

The initial codeless playbook node includes the Inputs and Outputs tabs, where optional sample data can be provided to illustrate the expected data structure for both incoming playbook data and the final playbook output.

1. Click on the Edit button to return to mode.

2. Add an input parameter.

   

   1. Click on the Inputs tab within the root node popup.

   2. Click on the + New Input Parameter button to add data into this codeless playbook.

3. Input the relevant fields, then save the input.

   

   1. Enter a parameter name, display name, parameter type, and sample data within the New Parameter popup.

   2. Click on the Save button.

The user should now see an expanded accordion containing their sample data.

4. Add a return data for the initial playbook node.

   

   1. Click on an Output tab.

   2. Click on the Return Data category tab.

   3. Click on the + Add Return Data button.

5. Enter the command’s return data type, then click on the Save button.

   

6. Click on the button.

   

Preprocessing the Data

Data preprocessing for the event pipeline is performed according to business requirements and can be accomplished through various methods, including the straightforward use of a data formatter.

1. Attach a Data Formatter task onto the initial playbook task node.

2. Input formatting logic to transform data, in Jinja syntax.

   

Preparing Preprocessed Data for Use

A Passdown task will be used to construct the return data for the codeless playbook, enabling it to be used in the Using the Codeless Playbook as Data Formatter section.

1. Attach a Passdown task onto the data formatter.

   

2. Click on the Passdown task node, then enter in your input parameters.

   

   1. Destination Field: Choose the Return Data option for the case of a data formatter.

   2. Destination JSON Path (Optional): Used to specify the top-level JSON key name for the data provided in the third parameter. For instance, to set the top-level key name as demo, enter $.demo.

   3. Data: The value for the corresponding key specified in the second parameter (Destination JSON Path).

{
    "AB": "BC",
    "BC": "DE"
}

{
    "AB": "BC",
    "BC": "DE"
}

{
  "demo": {
    "AB": "BC",
    "BC": "DE"
  }
}

READER NOTE

Using a Passdown task in this manner is analogous to invoking the returnOutputModel() function in a Python utility command with only the resultData parameter passed.

3. Click on the Dynamic toggle for the Data input parameter, then click on the icon.

   

4. Select and save the data formatter’s returnData path.

   

5. Click on the button.

6. Click on the Submit button to transition this codeless playbook into mode.

   

Using the Codeless Playbook as Data Formatter

1. Click on the Configuration navigation link, then click on the Integrations module.

2. Look up an integration command, then click on the Fetch Event (or Fetch Incident) command.

   

3. Toggle on Webhook Authentication, then click on a webhook authentication option (API Key or JWT).

   

4. Click into an Event Ingestion key, then click on the Additional Settings accordion.

5. Select the codeless playbook utility command under the Data Formatter dropdown.