Attach a note to a timeline event

POST

/timeline/annotations

curl --request POST \
  --url https://example.com/api/v1/timeline/annotations \
  --header 'Content-Type: application/json' \
  --data '{ "source": "sync", "eventId": 1, "body": "example" }'

• API v1

Requires an authenticated user (or AUTH-bypass). The referenced event must exist (404 otherwise, so a note is never born dangling).

Request Body^required

Media typeapplication/json

object

source

required

The event source a timeline event originates from.

string

Allowed values: sync canary snapshot rollback

eventId

required

integer

body

required

string

>= 1 characters <= 4000 characters

Responses

201

Annotation created

Media typeapplication/json

A user note attached to a single timeline event.

object

id

required

integer

source

required

The event source a timeline event originates from.

string

Allowed values: sync canary snapshot rollback

eventId

required

integer

body

required

string

authorUserId

required

integer

nullable

authorName

required

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "source": "sync"
}

400

Invalid body or source

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

401

Authentication required

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

404

Referenced event not found

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}

500

Failed to create annotation

Media typeapplication/json

object

error

required

Error message

string

Example^generated

{
  "error": "example"
}