Any time a comment is left on any item in Staffcircle a comment created event is raised. You can distinguish what a comment is for based on the type and the ‘relatedItemId’. A comment on a person is a direct message to this person.
|
Comment Template |
{ "id": <int>, "relatedItemId": <int>, "itemType": <itemType>, "comment": <string – comment body>, "comments": [<replyingComment>], "attachedDocumentIds": [<int>], "likesPersonIds": [<int>], "createdAt": <string ISO 8601 Date>, "createdByPersonId": <int>, "modifiedAt": <string ISO 8601 Date>, "modifiedByPersonId": <int> }
|
|
itemType Values |
objective, taskitem, form, review, absenceitem, commissionplan, article, feedback, person |
|
comments |
The comments array contains items identical to this one which are replying comments with this comment as the parent. |
Json Schema (for use with MS Power Automate)
{
"type": "object",
"properties": {
"subjectType": {
"type": "string"
},
"changeType": {
"type": "string"
},
"subjectFrontEndUrl": {
"type": "string"
},
"timeStamp": {
"type": "string"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"relatedItemId": {
"type": "integer"
},
"itemType": {
"type": "string"
},
"comment": {
"type": "string"
},
"parentCommentId": {
"type": "integer"
},
"comments": {
"type": "array"
},
"attachedDocumentIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"likesPersonIds": {
"type": "array",
"items": {
"type": "integer"
}
},
"createdAt": {
"type": "string"
},
"createdByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
},
"modifiedAt": {
"type": "string"
},
"modifiedByPerson": {
"type": "object",
"properties": {
"PersonId": {
"type": "integer"
},
"FirstName": {
"type": "string"
},
"FamilyName": {
"type": "string"
},
"Email": {
"type": "string"
}
}
}
}
},
"differences": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"oldValue": {
"type": "string"
},
"newValue": {
"type": "string"
}
},
"required": [
"path",
"oldValue",
"newValue"
]
}
}
}
}