Note
The Note resource provides details related to a note associated with a contact, incident or other entity within the system. It serves as a way to document and communicate information about a contact or incident.
Events
The following events are available for notes:
| Event Type | Description |
|---|---|
note.created | Triggered when a new note is added to an incident or contact |
note.updated | Triggered when any note information is modified |
note.deleted | Triggered when a note is removed |
The Note object
Attributes
- objectstring
Type of the note, always "Note".
- idstring
The unique identifier of the note.
- statusstring
The status of the note, either "public" or "private".
- parent_idstring | null
The unique identifier of the parent note, if any.
- notestring
The content of the note.
- typestring
The type of the note indicates the higher level object the note belong ("Enterprise Referral - Liability Decision").
- repliesArray<Note>
An array of reply notes.
- noteable_typestring
The type of the object the note is associated with, either "Contact" or "Incident".
- noteable_idstring
The unique identifier of the object the note is associated with.
- created_atstring
The timestamp when the note was created.
- updated_atstring
The timestamp when the note was last updated.
interface Note {
object: "Note";
id: string;
status: "public" | "private";
parent_id: string | null;
note: string;
type: string;
replies: Array<Note>;
noteable_type: "Contact" | "Incident";
noteable_id: string;
created_at: string;
updated_at: string;
}