Automate Extractor Guide

.vitepress/sidebars/app/guides.ts

@@ -300,6 +300,10 @@ export const guidesSidebar: DefaultTheme.SidebarItem[] = [
         text: "Avoiding Rate-Limiting Protections",
         link: "/app/guides/automate_rate_limiting",
       },
+      {
+        text: "Customizing Result Columns with Extractors",
+        link: "/app/guides/automate_extractors",
+      },
     ],
   },
   {

src/app/guides/automate_extractors.md

@@ -0,0 +1,19 @@
+---
+description: "A step-by-step guide to using extractors in Caido's Automate feature to create custom columns."
+---
+
+# Customizing Result Columns with Extractors
+
+The `Extractors` tab of an Automate session allows you to create custom columns in a session's result table. Values for these columns are determined based on whether or not a matching condition is met in the responses to the requests.
+
+To configure an extractor, define the matcher in the `Regex` input field.
+
+[Workflows](/app/concepts/workflows_intro.md) can be applied to matched data that will be presented as the value of a custom column.
+
+To test the matcher, input test data into the `Body` input field and **click** on the `Test` button. Successful matches will reflect the data in the `Result` field.
+
+<img alt="Extractor configuration." src="/_images/automate_extractor.png" center/>
+
+Once an extractor has been configured, it will be applied to the session and the custom will be presented in the result table.
+
+<img alt="Extractor results." src="/_images/automate_extractor_results.png" center/>

src/app/quickstart/automate.md

@@ -22,6 +22,7 @@ The `Automate` interface gives you the ability to send requests programatically.
 - [Sending Multiple Payloads](/app/guides/automate_multiple.md)
 - [Preprocessing Payloads](/app/guides/automate_preprocessors.md)
 - [Avoiding Rate-Limiting Protections](/app/guides/automate_rate_limiting.md)
+- [Customizing Result Columns with Extractors](/app/guides/automate_extractors.md)
 :::
 
 <LabContainer :labs="[{name: 'IDOR Vulnerability Lab', url: 'https://labs.cai.do/idor.php'}, {name: 'Hidden Dashboard Lab', url: 'https://labs.cai.do/hiddenDashboard.php'}]" />