StatusDashboard
EventsNotes

Create note

Add an internal note to an event.

View Markdown

POST /app/events/{id}/notes

Adds a new internal note to the event. Notes are never visible on published status dashboards.


Path parameters

ParameterDescription
idThe event ID.

Request

See API Basics for required headers.

Request body

FieldTypeRequiredDescription
notestringYesNote text. Max 5,000 characters.

Sample request

curl -X POST https://api.statusdashboard.com/app/events/4f8b2e1a-3c7d-4e9f-a0b1-c2d3e4f56789/notes \
  -H "Authorization: Bearer bcf847abf5c6:def456" \
  -H "Content-Type: application/json" \
  -d '{
    "note": "Escalated to database team at 10:15 UTC. Pager duty alert sent."
  }'

Sample response

Status: 201 Created

{
  "note": {
    "noteId": "2e8c5b9a-4d7f-4a0b-b2d4-e5f6789abcde",
    "timestamp": "2026-04-25T10:15:00.000Z",
    "note": "Escalated to database team at 10:15 UTC. Pager duty alert sent.",
    "author": "user@example.com",
    "isEdited": false
  }
}

Response fields match List notes — Note fields.


Error responses

StatusWhen
400Validation error — note text missing or too long.
403Insufficient permissions.
404Event not found.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.