Skip to main content
POST
Create
🔑 Requires the alerts.edit scope.

Authorizations

Authorization
string
header
required

API key from your incident.io dashboard (Settings → API keys)

Body

application/json
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"

alert_group_id
string

ID of the alert group to add the note to. Provide exactly one of alert_id or alert_group_id.

Example:

"01HB9Z8WANK6P870EA6S7TK1DS"

alert_id
string

ID of the alert to add the note to. Provide exactly one of alert_id or alert_group_id.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

Response

201 - application/json

Created response.

alert_note
object
required