Skip to main content

NoteEvent

Payload for an operator note created during a build

type NoteEvent {
  seq: Int!
  at: Time!
  id: String!
  externalId: String!
  text: String
  metadata: JSON
  images: [String!]
  eventType: String!
  type: NoteType
  state: NoteState
}

Fields​

NoteEvent.seq ● Int! non-null scalar​

Sequential identifier for the created note.

NoteEvent.at ● Time! non-null scalar​

Time the note was created

NoteEvent.id ● String! non-null scalar​

Unique ID of the note

NoteEvent.externalId ● String! non-null scalar​

External ID of the note (e.g ticket id from external ticketing system)

NoteEvent.text ● String scalar​

Custom text of this note as entered by the operator

NoteEvent.metadata ● JSON scalar​

Additional details (e.g. about parts entered) for this note

NoteEvent.images ● [String!] list scalar​

URL paths to images attached to this note

NoteEvent.eventType ● String! non-null scalar​

Whether this is a new note or an update to an existing note

NoteEvent.type ● NoteType object​

The definition of the note type associated with this note

NoteEvent.state ● NoteState object​

The state of the build when the note was created

Returned By​

noteEvents query ● noteEventsStream subscription