Alert Notes
API endpoints for alert notes
- Headings (
#,##,###) - Bold and italic text formatting
Strikethroughtext- Inline
codeand 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 (
---)
), task lists, and footnotes are not
supported, and will be stripped or rendered as plain text.
The alert note object
Markdown body of the note
"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"
When this note was first created
"2026-05-28T15:30:00Z"
Show child attributes
Show child attributes
{
"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"
}
}
Unique identifier for the alert note
"01J1X9J85C7Y12G8P8W8K55Q5Y"
Images attached to the current version of the note, with signed URLs valid for 10 minutes
Show child attributes
Show child attributes
[
{
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"url": "https://storage.googleapis.com/incident-io/images/..."
}
]
When this note was last updated
"2026-05-28T15:35:00Z"
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.
"01HB9Z8WANK6P870EA6S7TK1DS"
ID of the alert this note is attached to. Exactly one of alert_id or alert_group_id is set; the other is null.
"01FCNDV6P870EA6S7TK1DSYDG0"
When this note was last edited, only set if it has been edited at least once since creation
"2026-05-28T15:35:00Z"
Was this page helpful?
{
"content": "Customer reports **checkout 500s** starting ~14:32 UTC. Investigating `payments-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": "2026-05-28T15:30:00Z",
"creator": {
"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": "01J1X9J85C7Y12G8P8W8K55Q5Y",
"images": [
{
"id": "01G0J1EXE7AXZ2C93K61WBPYEH",
"url": "https://storage.googleapis.com/incident-io/images/..."
}
],
"updated_at": "2026-05-28T15:35:00Z",
"alert_group_id": "01HB9Z8WANK6P870EA6S7TK1DS",
"alert_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"last_edited_at": "2026-05-28T15:35:00Z"
}