Response actions
Give analysts buttons that ask your automation platform to act, such as isolating an endpoint or blocking an address.
Overview
A response action is a button on the Respond tab of a case, an asset or an indicator. Pressing it sends a webhook to your automation platform, for example n8n, Shuffle or the API of your endpoint protection product. The platform does the work, and DFIRe records who pressed the button, when, and what the webhook answered.
An example: an endpoint raises a malware alert. Your automation opens an incident in DFIRe and adds the endpoint to it as an asset. The analyst opens the asset's Respond tab and presses Isolate endpoint. The webhook sends the endpoint's hostname, taken from one of the asset's fields, to the platform. The platform isolates the endpoint and writes a timeline entry on the case when it has finished.
Each response action has one scope, which decides where its button appears:
| Scope | Where the button appears | Applies to |
|---|---|---|
| Case | The case's Respond tab | Cases of the playbooks you choose, or of all playbooks |
| Item | The Respond tab of an asset | Assets of the item types you choose, or of all item types. Evidence items never get a response action. |
| IOC | The Respond tab of an indicator's intelligence page | Indicators of the IOC types you choose, or of all IOC types |
A case or an asset shows the Respond tab only when at least one response action applies to it. An indicator shows the tab when at least one IOC response action exists, and the tab lists the actions for the indicator's type.
Defining a response action
Response actions live in Settings → Response Actions, under Integrations. Only a superuser opens the tab, as with webhooks.
- Choose New response action
-
Name the button
The Label is the text on the button. DFIRe fills in the Webhook trigger ID from the label. A webhook subscribes to this ID. It takes letters, digits, dots, hyphens and underscores, up to 100 characters, and must be unique within its scope.
-
Choose the scope
Case, Item or IOC. The webhook trigger ID cannot change after you create the action, because webhooks refer to it. You can change the scope later. Changing the scope disconnects the action from all its webhooks and clears the playbooks, item types or IOC types it applied to.
-
Describe it
The Description shows beside the button. Tell the analyst what the button does, for example "Isolates the host through the XDR." Choose a Button colour: blue, green, yellow or red.
-
Choose where it applies
Turn on All playbooks, All item types or All IOC types to apply the action everywhere in its scope, including playbooks and types created later. Otherwise tick the playbooks, item types or IOC types it applies to. An action with nothing ticked applies nowhere.
-
Create the response action
The list shows how many webhooks deliver the action. No webhook means none does yet, and the button cannot run.
The item type list and the playbook list in Settings show how many response actions apply to each item type and playbook. Deleting a response action removes it from every webhook that delivered it. A webhook left with no response action of that scope stops subscribing to the scope's event.
A settings export carries the response actions, and names their playbooks and item types by name. See Data portability.
Connecting a webhook
A response action sends nothing until a webhook or an email notifier delivers it.
-
Open the notifier
Go to Settings → Webhooks & Email and create a notifier, or open one. See Creating an Outgoing Webhook.
-
Select the response event
Under Response actions, select Case Response, Item Response or IOC Response.
-
Pick the response actions
Choose Any trigger to deliver every response action of that scope, or Specific triggers and pick them by name. DFIRe saves the notifier only when each selected event has a choice.
-
Write the payload
Use the template variables to send what the platform needs.
trigger.slug(the webhook trigger ID) andtrigger.labelname the response action that someone ran. A case or item response also carriescase.*, the person who pressed the button asuser.*, and for an item responseitem.*. An IOC response carriesioc.*.
An item type's own fields are available as {{item.attributes.key}}, where key is the field's database key in the item type's Item Attributes table. For the example above, an Endpoint item type with a hostname field and this payload:
{
"action": "{{trigger.slug}}",
"case": "{{case.case_number}}",
"hostname": "{{item.attributes.hostname}}",
"requested_by": "{{user.username}}"
}
The event_type of a delivery names the scope and the webhook trigger ID: case_trigger:id, item_trigger:id or ioc_trigger:id.
When a button is disabled
On a case or an asset, DFIRe checks each response action before it shows the button. DFIRe disables a button that cannot run and shows the reason beside it:
- No webhook connected: no enabled notifier delivers the action.
- Missing: followed by variable names, such as
item.attributes.hostname. A notifier that delivers the action uses acase.*oritem.*variable that is empty on this record. Fill in the field on the case or the asset, and the button becomes available. If the record does not have the field, add it with Add attribute. On a case, it is in the Attributes dialog. On an asset, it is on the Item Details tab. Foritem.attributes.hostname, add an attribute namedhostname.
DFIRe reads the payload template of every notifier that delivers the action, and the subject and body of an email notifier. A value is missing when the record does not have it or when it is empty. A notifier with an empty payload template sends the default payload and needs no particular value. DFIRe checks again when you press the button, so it never sends a webhook with a missing value.
DFIRe also disables the buttons, without a reason, when you may not run a response on the record. See Who may run a response.
The Respond tab of an indicator does not make these checks. Its button reports an error when no notifier delivers the action.
Running a response
Press the button and confirm. DFIRe sends the webhook to every enabled notifier that delivers the action, waits for the answers, and reports the result. A message such as SOC automation: HTTP 200 OK names each notifier and its answer.
DFIRe sends a response once. It never retries a failed response on its own, because a response that runs later than intended can do harm. To try again, press the button again.
DFIRe records every run:
- Execution History under the button lists the latest runs of that action, with who ran it, when, and the answer.
- A case or asset response adds a timeline entry: Response triggered: with the label, and the asset's name for an asset. Its description holds the answer.
- The audit log records the run and the person who ran it.
Who may run a response
A response on a case needs the right to edit the case. A response on an asset needs the right to edit items. In both cases you must be the case's lead investigator or an investigator on it, or hold the right to edit all cases. The Standard user, Team Lead and DFIRe Admin roles hold these rights. View Only and case viewers can see the Respond tab and its history, but not run a response.
A response on an indicator needs the rights to view and to export indicators. See Indicators of compromise: Permissions.
Some limits apply to every user, superusers included:
- A closed or archived case runs no response. Reopen the case first.
- Responses run from the web application, the REST API and Slack. MCP offers no way to run one.
Reporting back
The automation platform reports the outcome through the REST API, with an API key of its own. Common ways are a timeline entry on the case (POST /api/cases/{id}/timeline/), a note, or a triage flag on the asset. A flag can add its own timeline entry. See Triage Flags.
To let the platform find an asset, give the asset an External Reference, such as its hostname. The platform looks it up with GET /api/items/?case={id}&external_reference={value}, and the match ignores case.