Skip to main content

Add Case Decision

The ADD_CASE_DECISION event is triggered whenever new decision added in the case.

Attributes​

eventstring
The name of the event that was triggered. For this webhook, the value will always be `ADD_CASE_DECISION`.
payloadobject
The main object containing all data related to the event.
Show child attributes
decisionobject
An object containing the full details of the decision that was added to the case.
Show child attributes
idstring<UUID>
The unique identifier for the decision.
isApprovedboolean
Indicates if the decision was an approval (`true`) or denial (`false`).
isNoDecisionboolean
Indicates if the action was marked as 'no decision' made.
startDatestring<date-time>
The effective start date for the decision's validity period.
endDatestring<date-time>
The effective end date for the decision's validity period.
decisionTextstring
Any text or notes associated with the decision.
categorystring | null
The category of the decision, if applicable.
createdAtstring<date-time>
The ISO 8601 timestamp of when the decision was created.
visitTypestring
Allowed values:NO_SHOW,ASYNC_TEXT_EMAIL,SYNC_VIDEO,SYNC_PHONE,ORDER_FORM
The type of visit associated with this decision.
addedByobject
An object containing the details of the user who added the decision.
Show child attributes
firstNamestring
The user's first name.
lastNamestring
The user's last name.
titlestring
The user's professional title.
emailstring
The user's primary email address.
phoneNumberstring
The user's phone number.
npistring
The user's National Provider Identifier.
deastring
The user's DEA number.
addressstring
The user's primary address line.
citystring
The city of the user's address.
statestring
The state of the user's address.
postalCodestring
The postal code of the user's address.
medInfoarray<object>
A list of medical information objects related to the decision.
Show child attributes
idstring<UUID>
Unique ID for the medical info record.
medicinestring
Name and strength of the medicine.
dosagestring
Dosage instructions.
refillCountinteger
Number of allowed refills.
pharmacyInstructionsstring
Special instructions for the pharmacy.
dosingFrequencystring
How often the dose should be taken.
isRefillboolean
Indicates if this is a refill.
treatmentPeriodstring
The duration of the treatment period.
isPriorAuthRequestedboolean
Indicates if prior authorization was requested.
formResponseobject
An object containing details about the form response that may be associated with this decision.
Show child attributes
idstring<UUID>
The unique ID for the form response.
formobject
Details about the form that was submitted.
Show child attributes
namestring
The name of the form.
descriptionstring
A brief description of the form's purpose.
responsesarray<object>
A list of the actual responses submitted in the form.
Show child attributes
idstring<UUID>
Unique ID for the individual response.
questionobject
The question that was answered.
Show child attributes
indexinteger
The order of the question in the form.
typestring
Allowed values:TEXT,SINGLESELECT,MULTISELECT,DATE,FILE,BOOLEAN,DATERANGE,STATEMENT,WIDGET_STATE_PICKER,WIDGET_BMI,WIDGET_VISIT_TYPE,WIDGET_USER_ID_DOCUMENT
The type of form field.
textstring
The text of the question.
textstring
The answer provided by the user.
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_DECISION",
  "payload": {
    "decision": {
      "id": "292579e4-c2ba-45e0-b540-1141d748509a",
      "isApproved": true,
      "isNoDecision": false,
      "startDate": "2025-09-04T00:00:00.000Z",
      "endDate": "2025-10-04T00:00:00.000Z",
      "decisionText": "",
      "category": null,
      "createdAt": "2025-09-03T23:24:31.127Z",
      "visitType": "SYNC_VIDEO",
      "addedBy": {
        "firstName": "Ritik-1-Med",
        "lastName": "Parikh-1-Med",
        "title": "",
        "titleSuffix": "",
        "email": "ritik.parikh+med1@carevalidate.com",
        "phoneNumber": "+12285437347",
        "npi": "6583475637",
        "dea": "WSASDERTF",
        "address": "goll",
        "address2": null,
        "city": "ds",
        "state": "GA",
        "postalCode": "42342",
        "country": null
      },
      "medInfo": [
        {
          "id": "87f336b6-f72e-4300-ba07-a186405d2873",
          "medicine": "Cyanocobalamin/Semaglutide 5ml Vial Injectable (Strength 1mg/ml)",
          "dosage": "Inject 1ml (1mg) Subcutaneously Once Weekly for 4 Weeks",
          "refillCount": 6,
          "pharmacyInstructions": "sp inst to pharmacy",
          "dosingFrequency": "Daily",
          "externalId": null,
          "isRefill": true,
          "treatmentPeriod": "Week 9",
          "isPriorAuthRequested": true
        }
      ]
    },
    "formResponse": {
      "id": "800c21c8-1157-45eb-9de4-3b682924d932",
      "form": {
        "name": "Visit type",
        "description": ""
      },
      "responses": [
        {
          "id": "b897f1b0-64d7-4e54-b8cc-acf9090cc863",
          "isArchived": false,
          "question": {
            "index": 2,
            "type": "TEXT",
            "text": "weight",
            "isPHI": false,
            "options": [],
            "required": true
          },
          "text": "ef",
          "createdAt": "2025-09-03T22:06:16.382Z"
        },
        {
          "id": "76c64cc2-aabc-4b45-ab4c-f5d4e5ac1c20",
          "isArchived": false,
          "question": {
            "index": 1,
            "type": "WIDGET_VISIT_TYPE",
            "text": "Visit type",
            "isPHI": false,
            "options": [
              ""
            ],
            "required": true
          },
          "text": "NO_SHOW",
          "createdAt": "2025-09-03T22:06:16.382Z"
        }
      ]
    },
    "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-09-03T23:24:31.129Z",
      "assignedAt": "2025-08-06T18:04:26.412Z",
      "inProgressAt": "2025-09-03T22:56:27.563Z",
      "closedAt": "2025-09-03T23:24:31.097Z",
      "isArchived": false,
      "isEscalated": true,
      "isImported": false,
      "referralCode": null,
      "closedBy": "YaM948FdwiQa3Ek3GCnYsnZTTSW2",
      "inProgressBy": "YaM948FdwiQa3Ek3GCnYsnZTTSW2",
      "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": "58a5e76c-f737-4c29-8077-837a545791f0",
      "type": "ADD_CASE_DECISION",
      "isPHI": false,
      "isRestricted": false,
      "timestamp": "2025-09-03T23:24:31.127Z",
      "valueBefore": null,
      "valueAfter": "APPROVED",
      "actor": {
        "id": "YaM948FdwiQa3Ek3GCnYsnZTTSW2",
        "firstName": "Ritik-1-Med",
        "lastName": "Parikh-1-Med",
        "email": "ritik.parikh+med1@carevalidate.com"
      },
      "targetUser": null
    }
  }
}