Skip to main content
Manage notes attached to alerts. Notes let your team capture context, decisions, and investigation findings against an individual alert without needing to declare an incident. Note content is stored and returned as Markdown. The following formatting is supported:
  • Headings (#, ##, ###)
  • Bold and italic text formatting
  • Strikethrough text
  • Inline code and fenced code blocks
  • Bullet lists and numbered lists
  • Blockquotes
  • Links using Markdown link syntax — bare URLs are not auto-linked
  • Tables (GitHub-flavoured Markdown)
  • Horizontal rules (---)
Raw HTML, image syntax (![alt](url)), task lists, and footnotes are not supported, and will be stripped or rendered as plain text.

​
The alert note object

​
content
string
required

Markdown body of the note

Example:

"Customer reports **checkout 500s** starting ~14:32 UTC. Investigatingpayments-api.\n\n- Error rate: ~12% on/checkout\n- Region:eu-west-1\n- See [dashboard](https://grafana.example.com/d/abc)\n"

​
created_at
string<date-time>
required

When this note was first created

Example:

"2026-05-28T15:30:00Z"

​
creator
object
required
Example:
{
  "api_key": {
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "My test API key"
  },
  "user": {
    "email": "lisa@incident.io",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Lisa Karlin Curtis",
    "role": "viewer",
    "slack_user_id": "U02AYNF2XJM"
  }
}
​
id
string
required

Unique identifier for the alert note

Example:

"01J1X9J85C7Y12G8P8W8K55Q5Y"

​
images
object[]
required

Images attached to the current version of the note, with signed URLs valid for 10 minutes

Example:
[
  {
    "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "url": "https://storage.googleapis.com/incident-io/images/..."
  }
]
​
updated_at
string<date-time>
required

When this note was last updated

Example:

"2026-05-28T15:35:00Z"

​
alert_group_id
string

ID of the alert group this note is attached to. Exactly one of alert_id or alert_group_id is set; the other is null.

Example:

"01HB9Z8WANK6P870EA6S7TK1DS"

​
alert_id
string

ID of the alert this note is attached to. Exactly one of alert_id or alert_group_id is set; the other is null.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
last_edited_at
string<date-time>

When this note was last edited, only set if it has been edited at least once since creation

Example:

"2026-05-28T15:35:00Z"