Get Alerts

Get Alerts

curl --request GET \
  --url https://api.decodahealth.com/alerts \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "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>"
    }
  ],
  "total": 123
}

GET

alerts

Get Alerts

curl --request GET \
  --url https://api.decodahealth.com/alerts \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'

{
  "data": [
    {
      "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>"
    }
  ],
  "total": 123
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Query Parameters

page

integer | null

per_page

integer | null

sort_by

string | null

sort_direction

enum<string> | null

Available options:

asc,

desc

location_id

string | null

last_n_days

integer | null

action_required

boolean | null

alert_type

enum<string>[] | null

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

created_date

string | null

assigned_to_id

string | null

patient_id

string | null

tag_id

string[] | null

Response

Successful Response

data

AlertSummary · object[]

required

Show child attributes

data.id

string

required

data.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.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

Show child attributes

data.data.id

string

required

The unique identifier for the payment.

data.data.amount

integer

required

The total amount of the payment.

data.data.status

enum<string>

required

The current status of the payment.

Available options:

CANCELED,

CREATED,

FAILED,

IN_REVIEW,

PRESENTING,

PROCESSING,

SUCCEEDED

data.data.paymentMedium

string

required

The name of the payment medium.

data.data.createdDate

string<date-time>

required

The date and time the payment was created.

data.data.feeToPatient

integer

required

The fee charged to the patient for the transaction.

data.data.patientId

string | null

The ID of the patient associated with the payment.

data.data.payinId

string | null

The ID of the payin associated with the payment.

data.data.currency

string

default:USD

The currency in which the payment was made.

data.data.payinConfigId

string | null

The configuration ID for the payin.

data.data.paymentMethodId

string | null

The ID of the payment method used.

data.data.stripePaymentIntentId

string | null

Stripe's payment intent ID if used.

data.data.failedReason

string | null

Reason for payment failure if applicable.

data.data.updatedDate

string<date-time> | null

The date and time the payment was last updated.

data.data.fee

integer

default:0

The fee charged by the payment processor.

data.createdDate

string<date-time>

required

data.occurances

integer

required

data.actionRequired

boolean

default:false

data.resolvedDate

string<date-time> | null

data.tags

TagTiny · object[]

Show child attributes

data.tags.id

string

required

data.tags.name

string

required

data.assignedProvider

ProviderTiny · object

Show child attributes

data.assignedProvider.id

string

required

data.assignedProvider.firstName

string

required

data.assignedProvider.lastName

string | null

data.assignedProvider.email

string | null

data.assignedProvider.createdDate

string<date-time> | null

data.resolvingProvider

ProviderTiny · object

Show child attributes

data.resolvingProvider.id

string

required

data.resolvingProvider.firstName

string

required

data.resolvingProvider.lastName

string | null

data.resolvingProvider.email

string | null

data.resolvingProvider.createdDate

string<date-time> | null

data.patient

UserTiny · object

Show child attributes

data.patient.id

string

required

The unique identifier for the user.

data.patient.type

enum<string>

required

The type of user.

Available options:

PROVIDER,

PATIENT,

ASSISTANT

data.patient.firstName

string | null

The user's first name.

data.patient.lastName

string | null

The user's last name.

data.patient.phoneNumber

string | null

The user's phone number.

data.patient.email

string | null

The user's email address.

data.patient.locationId

string | null

The location of the user.

data.callId

string | null

data.messageId

string | null

data.emailId

string | null

data.mailId

string | null

data.eventId

string | null

data.formId

string | null

data.invoiceId

string | null

data.paymentId

string | null

data.paymentMethodId

string | null

data.chargeId

string | null

data.adjustmentId

string | null

data.refundId

string | null

data.depositId

string | null

total

integer

required

Get Alert Count Get Kpis

⌘I

Getting Started

API

Tenant

Webhook

Headers

Query Parameters

Response