Skip to main content
POST
Attach an internal note (e.g. findings from another tool) to an incident; never published

Authorizations

Authorization
string
header
required

An organization API key (obs_pub_…) sent as Authorization: Bearer <key>. Each key carries scopes; an endpoint lists the scope it needs.

Path Parameters

id
string<uuid>
required

Incident id.

Body

application/json
source
string
required

The tool or agent the finding comes from, shown as attribution, e.g. "AWS DevOps Agent" or "HolmesGPT".

Required string length: 1 - 80
Example:

"HolmesGPT"

body
string
required

The note, as plain text. It is displayed as text (never rendered as HTML or Markdown) and is visible only to members of the organization.

Required string length: 1 - 20000

Response

created

id
string<uuid>
incident_id
string<uuid>
source
string
body
string
visibility
enum<string>

Always internal: notes never appear on status pages or in subscriber notifications.

Available options:
internal
created_at
string<date-time>