Create Your First Runbook

🚀 Request Creation from Webhook Payload

This guide walks you through creating a solution and configuring a runbook to create requests using a JSON payload received via a webhook.

🧩 Step 1: Create a Solution

1. Navigate to the Solutions page
2. Click + New Solution

3. In the popup:
   
   • Enter Name (required)
   • Enter Description (optional)
4. Click Save

       ✅ Once saved:

• The solution is created
• You will be redirected to the Runbook page

⚙️ Step 2: Create a Runbook

1. Click + New Runbook
2. Provide:
   
   • Runbook Name
   • Description
3. Click Save
   

           ✅ You will be redirected to the Designer page, where you can build your workflow.

🔔 Step 3: Add a Trigger

1. Click + Select Trigger

2. From the list of available applications:
   
   • Select JSON Endpoint

3. Click Select & Choose the JSON Endpoint Trigger 

          ✅ Once selected: The trigger will now be added to the Designer

• A JSON Endpoint connection will be created automatically
• It will be available under the Connections page as an Inbound connection

🧾 Step 4: Configure JSON Payload (Body Schema)

      Click on the JSON Endpoint trigger to open the configuration panel.

       ⚠️ Important:

         The Body Schema is mandatory — it defines the structure of the incoming webhook payload.

‍

      Option 1: Add Fields Manually

1. Click + Add Field
2. Configure the following:
   
   • Field Label
   • Field ID
   • Type (e.g., string, number, boolean)

        Additional Settings:

• Mark fields as Required (for validation)
• Add default values if needed
• Configure advanced options

      Option 2: Import JSON Sample (Recommended)

1. Click the three-dot menu (⋯) in the Body Schema section
2. Select Import JSON Sample

3. Upload a sample JSON file (Sample webhook payload)

1. Click Generate Schema

        ✅ You will be redirected to the YAML schema view

🧪 Step 5: Validate & Save Schema

1. Review the generated schema carefully
2. Click Save Changes

       🔍 Validation:

• Any errors in the schema will be highlighted
• Fix any issues before saving

   ✅ If no errors are present:

• The JSON Endpoint trigger configuration is complete

🛠️ Step 6: Initialize and Map Dynamic Variables

To transform incoming data (like "warn") into specific system values (like "medium"), you must first declare the variable in your settings and then define the logic in the designer.

1. Declare in Settings:
   
   • Navigate to the Settings tab of your Runbook.
   • Under Runbook Variables, click + Add Field.
     

1. • Set the Field Label to Impact, the Field ID to impact, and the Type to String.
   • Click Save to "register" this Runbook variable.

2. Assign in Designer:
   
   • Return to the Designer tab and click the + Add Action Button below your Trigger.
     

2. • Search & Select the Assign Runbook Variable action.
     

2. • In the configuration panel, select impact from the ID dropdown.
     

2. Configure Logic:
   
   • Change the Value input mode to Proc.
   • Paste the following Ruby mapping logic into the editor:

‍✅ Result: You now have a custom Datapill named impact that you can drag-and-drop into any subsequent action (like a Xurrent Mutation) to set the priority dynamically!

🏗️ Step 7: Create the Request (Xurrent Mutation)

Now that your data is mapped and stored in the impact variable, you will use the Xurrent Connector to build the actual record.

1. Add the Action:
   
   • In the Designer, click the + Add Action below your previous step.
   • Search for and select the Xurrent Connector app.

• From the Action dropdown, select Xurrent Mutation.

2. Select Mutation Type:
   
   • In the configuration panel, set the Mutation field to requestCreate.

2. Configure the Payload (Input Configuration):
   
   • Locate the Input section and switch the toggle from Fixed to Proc.
   • Map your fields by dragging Datapills from the tray into the editor to match the following structure:

Sample :

‍

✅ Result: Your Runbook is now fully configured to receive an alert, translate the priority logic, and create a structured Incident in Xurrent.

Once this is completed, navigate to the Connections section and select the Xurrent Connector under Outbound Connections.

Next, configure the credentials. To retrieve these values, first set up the Client ID and Client Secret in the Environment Variables. Once configured, they will be available for selection within the connection variables.
Note : While Adding secrets in the Environment variables use type : Secret String only

Step 8: Validation

You can add validation logic to log whether the request was created successfully or to capture errors if it fails.

1. Click + Add Action and select If–Then–Else, then click Select.           

1. Once the action is created: 

• Set the condition to True
• Switch the mode to Proc
• Provide the required condition               

‍

3.  True Case:

Select the Log Message action to log the request ID

  In the input configuration, choose the Request ID field

‍False Case: Select the Fail action to stop the runbook execution

Map the error message from the Xurrent mutation to the message field in the input configuration

Once the setup is complete, click the three-dot menu at the top center and select Create Named Version. Provide a meaningful name so you can easily identify and restore this version in the future if needed.

Click on Save :

Then click the three-dot menu and select Promote to move your draft changes to the live version.

Once the solution is promoted, you can start sending sample payloads to the JSON webhook endpoint  in Step 1.