Create Case
thehive.create_case
ActionBusiness appsconnection required
Calls the TheHive API with the connection's credentials.
Open a new case, with its severity, TLP, tags and assignee.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- TheHive
- Secret shape
- the TheHive API key, or {"api_key": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
13 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
title The case title. | string | Yes | — | — | Phishing campaign against finance |
description The case description, as Markdown. | string | Yes | — | — | — |
severity Severity as TheHive's numeric code: 1 low, 2 medium, 3 high, 4 critical. | number | No | — | 1–4 | — |
tags Comma-separated tags to set on the record, e.g. phishing,external. | string | No | — | — | — |
tlp Traffic Light Protocol level as TheHive's numeric code: 0 white, 1 green, 2 amber, 3 red. Instances that define amber+strict also accept 4. | number | No | — | 0–4 | — |
pap Permissible Actions Protocol level as TheHive's numeric code, on the same 0 to 3 scale as TLP. | number | No | — | 0–4 | — |
status The case status to set. | string | No | — | one of "New", "InProgress", "Indeterminate", "FalsePositive", "TruePositive", "Other", "Duplicated" | — |
assignee Login of the analyst to assign the case to. | string | No | — | — | — |
summary The closing summary of the case. | string | No | — | — | — |
start_date When the case started, in epoch milliseconds. Defaults to now. | number | No | — | ≥ 0 | — |
case_template Name of a case template to apply, which pre-creates its tasks. | string | No | — | — | — |
custom_fields Custom field values as a JSON object keyed by custom-field name. | object | No | — | — | — |
extra Any further TheHive fields for this record, as a JSON object. These are merged last and win over the fields above. | object | No | — | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"title": "Phishing campaign against finance"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
_id TheHive's internal id for the case. | string | — |
number The human-facing case number. | number | — |
title The case title. | string | — |
description The case description, as Markdown. | string | — |
severity Severity as TheHive's numeric code. | number | — |
severityLabel The label TheHive shows for that severity. | string | — |
status Where the case is in its lifecycle, e.g. New or InProgress. | string | — |
stage The broader stage the status belongs to. | string | — |
tlp Traffic Light Protocol level as TheHive's numeric code. | number | — |
tlpLabel The label TheHive shows for that TLP level. | string | — |
pap Permissible Actions Protocol level as a numeric code. | number | — |
tags The tags carried by the case. | array | — |
assignee Login of the analyst the case is assigned to. | string | — |
startDate When the case started, in epoch milliseconds. | number | — |
_createdAt When the case was created, in epoch milliseconds. | number | — |
_createdBy Login of the user who created the case. | string | — |
{
"_createdAt": 0,
"_createdBy": "",
"_id": "",
"assignee": "",
"description": "",
"number": 0,
"pap": 0,
"severity": 0,
"severityLabel": "",
"stage": "",
"startDate": 0,
"status": "",
"tags": [],
"title": "",
"tlp": 0,
"tlpLabel": ""
}See Create Case run in a workflow.
In a technical demo we add the TheHive connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.