Skip to main content

Add Case Comment

The ADD_CASE_COMMENT event is triggered whenever new comment are added to a case. This webhook provides a full snapshot of the case, the new comment, and details about the activity that triggered the event.

Attributes​

eventstring
The name of the event that was triggered. For this webhook, the value will always be ADD_CASE_COMMENT.
payloadobject
The main object containing all data related to the event.
Show child attributes
commentsobject
An object containing the details of the new comment that was added.
Show child attributes
idstring<UUID>
The unique identifier for the comment.
textstring
The text content of the comment.
isRestrictedboolean
Indicates if the comment is for internal view only. `true` if restricted, `false` otherwise.
createdAtstring<date-time>
The ISO 8601 timestamp of when the comment was created.
formsarray
A list of forms that have any question contains Protected Health Information (PHI) Flag On.
authorobject
An object containing details about the user who posted the comment.
Show child attributes
idstring<UUID>
The unique identifier for the author.
firstNamestring
The first name of the author.
lastNamestring
The last name of the author.
emailstring
The email address of the author.
rolestring
Allowed values:USER,CASEMANAGER,CASEWORKER,ADMIN,CVADMIN,CVTPA
The role of the author within the system.
titlestring | null
The professional title of the author, if available.
titleSuffixstring | null
The suffix for the author's title (e.g., Jr., Sr.), if available.
npistring | null
The National Provider Identifier of the author, if applicable.
deastring | null
The DEA number of the author, if applicable.
organizationAccessarray<object>
A list of the user's roles within different organizations.
Show child attributes
rolestring
Allowed values:TPASUPPORT,TPAMEDICAL,TPALEGAL
If the user has a TPA role, they are assigned a specific role within the organization.
attachmentsarray<object>
A list of files attached to the comment.
Show child attributes
idstring<UUID>
The unique identifier for the attachment.
isRestrictedboolean
Indicates if the attachment is for internal view only.
isPHIboolean
Indicates if the attachment contains Protected Health Information (PHI).
fileNamestring
The original name of the uploaded file.
isDeletedboolean
Indicates if the attachment has been marked for deletion.
createdAtstring<date-time>
The ISO 8601 timestamp of when the attachment was uploaded.
uploadedByobject
An object containing details about the user who uploaded the file.
Show child attributes
idstring<UUID>
The unique identifier for the uploader.
firstNamestring
The first name of the uploader.
lastNamestring
The last name of the uploader.
contentstring<base64>
The Base64-encoded content of the file.
caseobject
An object containing the full details of the case at the time of the event.
Show child attributes
idstring<UUID>
The unique identifier for the case.
typestring
The type or category of the case (e.g., "GLP").
titlestring
The title of the case.
statusstring
Allowed values:OPEN,ASSIGNED,IN_PROGRESS,APPROVED,REJECTED,NO_DECISION
The current status of the case.
shortIdstring
A short, human-readable identifier for the case.
createdAtstring<date-time>
The timestamp when the case was created.
updatedAtstring<date-time>
The timestamp when the case was last updated.
assignedAtstring<date-time>
The timestamp when an assignee was first added to the case.
inProgressAtstring<date-time>
The timestamp when the case status changed to "IN_PROGRESS".
closedAtstring<date-time>
The timestamp when the case was closed. null if still open.
isArchivedboolean
Indicates if the case is closed/archived.
isEscalatedboolean
Indicates if the case is escalated.
isImportedboolean
Indicates if the case is imported from outside.
referralCodestring
Indicates if user have any referralCode.
closedBystring
The unique identifier for the user that case mark close.
inProgressBystring
The unique identifier for the user which make case in InProgress.
organizationIdstring<UUID>
The unique identifier for the case belongs which organization.
archiveReasonstring
Indicates if the case is archived any reason for it, null if still open.
productBundleobject
Details about the product bundle associated with the case.
Show child attributes
namestring
Indicates case product bundle name.
submitterobject
An object containing the details of the user who submitted the case.
Show child attributes
idstring
The unique identifier of the submitter.
firstNamestring
The first name of the submitter.
lastNamestring
The last name of the submitter.
emailstring
The email address of the submitter.
dobstring<date-time>
The date of birth of the submitter in ISO 8601 format.
genderstring
The gender of the submitter (e.g., MALE, FEMALE, OTHER).
phoneNumberstring
The phone number of the submitter, including country code.
addressstring
The primary address line of the submitter.
address2string
The secondary address line of the submitter, if applicable.
citystring
The city of the submitter's address.
statestring
The state or province of the submitter's address.
postalCodestring
The postal code of the submitter's address.
activityobject
An object that describes the specific action that triggered this webhook.
Show child attributes
idstring<UUID>
The unique identifier for this activity log entry.
typestring
Allowed values:CREATE_CASE,CHANGE_CASE_STATUS,ADD_CASE_COMMENT,DELETE_CASE_COMMENT,ADD_CASE_DECISION,ARCHIVE_CASE,ESCALATE_CASE,DEESCALATE_CASE,ADD_CASE_ESCALATION,REMOVE_CASE_ESCALATION,UPDATE_CASE_ESCALATION,DECISION_DELETED,ADD_CASE_ATTACHMENT,ADD_CASE_ASSIGNEE,REMOVE_CASE_ASSIGNEE,IMPORT_CASE,ADD_FORM_RESPONSE,UPDATE_FORM_RESPONSE,ADD_HR_REP,REMOVE_HR_REP,DELETE_ATTACHMENT,FOLLOWUP_EMAIL,PAYMENT_ADDED,PAYMENT_COMPLETED,PAYMENT_DELETED,PAYMENT_UPDATED,ORDER_CREATED,TEXT_INFO,REOPEN_CASE,SMS_SENT,SMS_RECEIVED,INBOUND_EMAIL,OUTBOUND_EMAIL,FOLLOWUP_FORM,ORDER_STATUS_CHANGED,ORDER_TRACKING_ADDED,PAYMENT_INFO_LINK_SENT,ADD_PAYMENT_INFO_USING_LINK,CALENDAR_EVENT_CREATED,CALENDAR_EVENT_RESCHEDULED,CALENDAR_EVENT_CANCELED,CALENDAR_EVENT_NO_SHOW,CALENDAR_EVENT_NO_SHOW_REMOVED,SUPPORT_NOTE_ADDED,SUPPORT_NOTE_UPDATED,SUPPORT_NOTE_COMPLETED,COMMENT_ACKNOWLEDGED,NOTE_ACKNOWLEDGED,VISIT_TYPE_CHANGED,PAYMENT_PREAUTHORIZED,SUBSCRIPTION_ADDED,SUBSCRIPTION_ACTIVATED,SUBSCRIPTION_COMPLETED,SUBSCRIPTION_PAUSED,SUBSCRIPTION_RESUMED,SUBSCRIPTION_CANCELLED,SUBSCRIPTION_UPDATED
The type of activity.
timestampstring<date-time>
The exact timestamp when the activity occurred.
actorobject
The user who performed the action (i.e., who added the new assignee).
Show child attributes
idstring<UUID>
The ID of the actor.
firstNamestring
The first name of the actor.
lastNamestring
The last name of the actor.
emailstring
The email of the actor.
targetUserobject
The user who was the target of the action (i.e., the user who was assigned).
Show child attributes
idstring<UUID>
The ID of the assigned user.
firstNamestring
The first name of the assigned user.
lastNamestring
The last name of the assigned user.
emailstring
The email of the assigned user.

Response​

{
  "event": "ADD_CASE_COMMENT",
  "payload": {
    "comment": {
        "id": "78efb1f8-f62d-455a-8b6f-72cf2c52fe70",
        "text": "Please find my data",
        "isRestricted": false,
        "createdAt": "2025-09-03T21:42:14.260Z",
        "forms": [{ "questions": [{ "isPHI": false }, { "isPHI": false }] }],
        "author": {
            "id": "WzvygANWTEcfsLlDW1K22WWS7dY2",
            "firstName": "Ritik-2",
            "lastName": "Parikh-2",
            "email": "ritik.parikh+02@carevalidate.com",
            "role": "USER",
            "title": null,
            "titleSuffix": null,
            "npi": null,
            "dea": null,
            "organizationAccess": [{ "role": "TPAMEDICAL" }]
        },
        "attachments": [{
            "id": "5e162d52-cf7f-46bd-b53e-dc8e29005a29",
            "isRestricted": false,
            "isPHI": false,
            "fileName": "logo.png",
            "isDeleted": false,
            "createdAt": "2025-09-03T22:07:48.071Z",
            "uploadedBy": {
                "id": "WzvygANWTEcfsLlDW1K22WWS7dY2",
                "firstName": "Ritik-2",
                "lastName": "Parikh-2"
            },
            "content": "base64 content"
        }]
    },
    "case": {
        "id": "ec7ebb4c-3a36-43bf-93f7-3c292020c281",
        "type": "GLP",
        "title": "Case for Ritik-2 Parikh-2",
        "status": "APPROVED",
        "shortId": "ADA-C1HM17",
        "createdAt": "2025-08-05T08:51:38.903Z",
        "updatedAt": "2025-08-06T18:04:51.722Z",
        "assignedAt": "2025-08-06T18:04:26.412Z",
        "inProgressAt": "2025-08-06T18:04:28.538Z",
        "closedAt": "2025-08-06T18:04:51.678Z",
        "isArchived": false,
        "isEscalated": true,
        "isImported": false,
        "referralCode": null,
        "closedBy": "DgHxzGRtS5gFzdL7cReiPzJcA852",
        "inProgressBy": "DgHxzGRtS5gFzdL7cReiPzJcA852",
        "organizationId": "652f45e9-eb17-4955-8197-4170e375327f",
        "archiveReason": null,
        "productBundle": {
            "name": "RITIK-GLSA-4"
        },
        "submitter": {
            "id": "WzvygANWTEcfsLlDW1K22WWS7dY2",
            "firstName": "Ritik-2",
            "lastName": "Parikh-2",
            "email": "ritik.parikh+02@carevalidate.com",
            "dob": "1998-12-17T00:00:00.000Z",
            "gender": "MALE",
            "phoneNumber": "+12286475628",
            "address": "1271 6th Avenue",
            "address2": "",
            "city": "New York",
            "state": "AK",
            "postalCode": "10020"
        }
    },
    "activity": {
    "id": "2c87f7a8-00f7-4db4-80e2-98cc77baa68c",
    "type": "ADD_CASE_COMMENT",
    "isPHI": false,
    "isRestricted": false,
    "timestamp": "2025-09-03T21:44:52.232Z",
    "valueBefore": null,
    "valueAfter": "Please Attach my documents",
    "actor": {
        "id": "WzvygANWTEcfsLlDW1K22WWS7dY2",
        "firstName": "Ritik-2",
        "lastName": "Parikh-2",
        "email": "ritik.parikh+02@carevalidate.com"
    },
    "targetUser": {
        "id": "4cNpFgLRTtPcEjbAH9ujWAv1zY03",
        "firstName": "Ritik-TPA-1",
        "lastName": "Parikh-TPA-1",
        "email": "ritik.parikh+tpa1@carevalidate.com"
      }
    }
  }
}