Create Alert
thehive.create_alert
ActionBusiness appsconnection required
Calls the TheHive API with the connection's credentials.
Raise an alert for triage. The source and source reference together identify it, so re-sending the same pair is refused as a duplicate instead of creating a second alert.
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
15 fields, 5 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 |
|---|---|---|---|---|---|
alert_type The alert type, as your instance classifies it, e.g. phishing. | string | Yes | — | — | phishing |
source The system the alert came from, e.g. the SIEM's name. | string | Yes | — | — | mail-gateway |
source_ref The source's own reference for this alert; unique per source. | string | Yes | — | — | MG-2026-1042 |
title The alert title. | string | Yes | — | — | — |
description The alert 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 | — |
date When the alert was raised, in epoch milliseconds. Defaults to now. | number | No | — | ≥ 0 | — |
external_link A link back to the alert in the source system. | string | No | — | url format | — |
case_template Case template to use if this alert is later promoted to a case. | string | No | — | — | — |
custom_fields Custom field values as a JSON object keyed by custom-field name. | object | No | — | — | — |
observables Observables to create with the alert, as a JSON array of objects with dataType and data keys. | array | No | — | array of object | — |
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.
{
"alert_type": "phishing",
"source": "mail-gateway",
"source_ref": "MG-2026-1042"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
_id TheHive's internal id for the alert. | string | — |
type The alert type, as sent by the source. | string | — |
source The system the alert came from. | string | — |
sourceRef The source's own reference for the alert. | string | — |
title The alert title. | string | — |
description The alert description, as Markdown. | string | — |
severity Severity as TheHive's numeric code. | number | — |
severityLabel The label TheHive shows for that severity. | string | — |
status Where the alert is in its triage lifecycle. | string | — |
stage The broader stage the status belongs to. | string | — |
tlp Traffic Light Protocol level as TheHive's numeric code. | number | — |
pap Permissible Actions Protocol level as a numeric code. | number | — |
tags The tags carried by the alert. | array | — |
date When the alert was raised, in epoch milliseconds. | number | — |
follow True when updates from the source keep flowing in. | boolean | — |
observableCount How many observables the alert carries. | number | — |
caseId Id of the case the alert was imported into, once it was. | string | — |
_createdAt When the alert was created, in epoch milliseconds. | number | — |
{
"_createdAt": 0,
"_id": "",
"caseId": "",
"date": 0,
"description": "",
"follow": false,
"observableCount": 0,
"pap": 0,
"severity": 0,
"severityLabel": "",
"source": "",
"sourceRef": "",
"stage": "",
"status": "",
"tags": [],
"title": "",
"tlp": 0,
"type": ""
}See Create Alert 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.