Add Observable To Alert
thehive.create_alert_observable
ActionBusiness appsconnection required
Calls the TheHive API with the connection's credentials.
Attach one or more observables to an alert before it is triaged.
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
11 fields, 3 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_id TheHive id of the alert. | string | Yes | — | — | ~41353304 |
data_type The observable type as your instance names it, e.g. ip, domain, url, hash, mail or fqdn. | string | Yes | — | — | ip |
data The observable value. Give several by separating them with commas — TheHive then creates one observable per value. | string | Yes | — | — | 8.8.8.8 |
message An analyst note stored alongside the observable. | string | No | — | — | — |
tags Comma-separated tags to set on the record, e.g. phishing,external. | string | No | — | — | — |
ioc Mark the observable as an indicator of compromise. | boolean | No | — | — | — |
sighted Mark the observable as seen in your own environment. | boolean | 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 | — |
ignore_similarity Keep this observable out of TheHive's similarity computations. | boolean | 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.
{
"alert_id": "~41353304",
"data": "8.8.8.8",
"data_type": "ip"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
items[]._id TheHive's internal id for the observable. | string | — |
items[].dataType The observable type, e.g. ip, domain, hash or mail. | string | — |
items[].data The observable value itself. | string | — |
items[].message The analyst note stored with the observable. | string | — |
items[].tlp Traffic Light Protocol level as TheHive's numeric code. | number | — |
items[].tlpLabel The label TheHive shows for that TLP level. | string | — |
items[].pap Permissible Actions Protocol level as a numeric code. | number | — |
items[].tags The tags carried by the observable. | array | — |
items[].ioc True when the observable is marked an indicator of compromise. | boolean | — |
items[].sighted True when the observable has been seen in the environment. | boolean | — |
items[].startDate When the observable was first seen, in epoch milliseconds. | number | — |
items[]._createdAt When the observable was created, in epoch milliseconds. | number | — |
count How many observables TheHive actually created. It can be lower than 'submitted' when a value already existed on the record. | number | — |
submitted How many values were sent in this call. | number | — |
{
"count": 0,
"items": [
{
"_createdAt": 0,
"_id": "",
"data": "",
"dataType": "",
"ioc": false,
"message": "",
"pap": 0,
"sighted": false,
"startDate": 0,
"tags": [],
"tlp": 0,
"tlpLabel": ""
}
],
"submitted": 0
}See Add Observable To 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.