Annotate Alert
signl4.annotate_alert
ActionChat & messagingconnection required
Calls the SIGNL4 API with the connection's credentials.
Add a text note to an alert's timeline, attributed to a user.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- SIGNL4
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- team_id, user_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 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 |
|---|---|---|---|---|---|
alert_id Id of the alert to act on, as signl4.list_alerts or signl4.trigger_alert returns it. | string | Yes | — | — | 2518975207516268778 |
text The note to add to the alert's timeline. | string | Yes | — | — | — |
user_id SIGNL4 user acting on the alert; overrides the connection's default user. | string | No | — | — | a1b2c3d4e5f6 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"alert_id": "2518975207516268778",
"user_id": "a1b2c3d4e5f6"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id Id of the annotation that was created. | string | — |
text The note as SIGNL4 stored it. | string | — |
userId The user the note is attributed to. | string | — |
type Annotation type; 1 is a text note. | number | — |
{
"id": "",
"text": "",
"type": 0,
"userId": ""
}See Annotate Alert run in a workflow.
In a technical demo we add the SIGNL4 connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.