Skip to main content
GET
/
alerts
/
{alert_id}
Get Alert
curl --request GET \
  --url https://api.decodahealth.com/alerts/{alert_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "id": "<string>",
  "type": "PATIENT_CREATED",
  "data": {
    "id": "<string>",
    "amount": 123,
    "status": "CANCELED",
    "paymentMedium": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "feeToPatient": 123,
    "patientId": "<string>",
    "payinId": "<string>",
    "currency": "USD",
    "payinConfigId": "<string>",
    "paymentMethodId": "<string>",
    "stripePaymentIntentId": "<string>",
    "failedReason": "<string>",
    "updatedDate": "2023-11-07T05:31:56Z",
    "fee": 0
  },
  "createdDate": "2023-11-07T05:31:56Z",
  "occurances": 123,
  "actionRequired": false,
  "resolvedDate": "2023-11-07T05:31:56Z",
  "tags": [],
  "assignedProvider": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "resolvingProvider": {
    "id": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "createdDate": "2023-11-07T05:31:56Z"
  },
  "patient": {
    "id": "<string>",
    "type": "PROVIDER",
    "firstName": "<string>",
    "lastName": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "locationId": "<string>"
  },
  "callId": "<string>",
  "messageId": "<string>",
  "emailId": "<string>",
  "mailId": "<string>",
  "eventId": "<string>",
  "formId": "<string>",
  "invoiceId": "<string>",
  "paymentId": "<string>",
  "paymentMethodId": "<string>",
  "chargeId": "<string>",
  "adjustmentId": "<string>",
  "refundId": "<string>",
  "depositId": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

alert_id
string
required

Response

Successful Response

id
string
required
type
enum<string>
required
Available options:
PATIENT_CREATED,
PATIENT_UPDATED,
APPOINTMENT_CANCELLED,
APPOINTMENT_UPDATED,
APPOINTMENT_REQUEST,
APPOINTMENT_SCHEDULED,
SELF_SCHEDULED_APPOINTMENT,
SELF_SCHEDULED_APPOINTMENT_CANCELLED,
SELF_SCHEDULED_APPOINTMENT_UPDATED,
BLOCK_CREATED,
BLOCK_CANCELLED,
BLOCK_UPDATED,
SHIFT_CREATED,
SHIFT_CANCELLED,
SHIFT_UPDATED,
PAYMENT_CREATED,
PAYMENT_FAILED,
PAYMENT_SUCCEEDED,
PLANNED_PAYMENT_FAILED,
PLANNED_PAYMENT_SUCCEEDED,
CHARGE_CREATED,
REFUND_CREATED,
REFUND_FAILED,
REFUND_SUCCEEDED,
ADJUSTMENT_CREATED,
ADJUSTMENT_FAILED,
ADJUSTMENT_SUCCEEDED,
INVOICE_UPDATED,
INVOICE_STATUS_UPDATE,
INVOICE_SET_UPDATED,
CHARGE_PAYMENT_CREATED,
CALL_RECEIVED,
CALL_MADE,
CALL_ONGOING,
MESSAGE_RECEIVED,
MESSAGE_SENT,
MESSAGE_DELIVERED,
MESSAGE_FAILED,
EMAIL_RECEIVED,
EMAIL_SENT,
MAIL_SENT,
MAIL_DELIVERY_FAILED,
FORM_SUBMITTED,
NOTIFICATION,
APPOINTMENT_CHECKLIST_UPDATED,
LOW_PATIENT_REVIEW,
CHAT_UPDATE,
RAINFOREST_PAYIN_FAILED,
RAINFOREST_PAYIN_PROCESSING,
RAINFOREST_POS_PAYIN_CANCELLED,
RAINFOREST_DEPOSIT_IN_REVIEW,
RAINFOREST_DEPOSIT_SUCCEEDED,
RAINFOREST_DEPOSIT_FAILED,
STOCK_LOW,
STOCK_ADDED,
STOCK_ARCHIVED,
STOCK_LINKED_TO_ITEM,
STOCK_UNLINKED_FROM_ITEM,
STOCK_UPDATED,
STOCK_DRAWDOWN,
SHIPMENT_RECEIVED,
SHIPMENT_UPDATED,
SHIPMENT_ARCHIVED,
ITEM_CREATED,
ITEM_UPDATED,
ITEM_ARCHIVED,
INVENTORY_ACTION
data
Payment · object
required
  • Payment
  • RefundSummary
  • AdjustmentSummary
  • ChargeSummary
  • ServiceDetail
  • MessageSummary
  • Payment
  • PatientSummary
  • InvoiceUpdate
  • LowPatientReviewData
  • InvoiceSetUpdate
  • Notification
  • CallSummary
  • EventDetail
  • UpdatedAppointment
  • AnsweredFormTiny
  • PlannedPaymentSummary
  • PayinEvent
  • ChatUpdate
  • InventoryLog
  • ChargePaymentUpdate
  • AppointmentChecklistUpdatedData
  • DepositEvent
createdDate
string<date-time>
required
occurances
integer
required
actionRequired
boolean
default:false
resolvedDate
string<date-time> | null
tags
TagTiny · object[]
assignedProvider
ProviderTiny · object
resolvingProvider
ProviderTiny · object
patient
UserTiny · object
callId
string | null
messageId
string | null
emailId
string | null
mailId
string | null
eventId
string | null
formId
string | null
invoiceId
string | null
paymentId
string | null
paymentMethodId
string | null
chargeId
string | null
adjustmentId
string | null
refundId
string | null
depositId
string | null