Webhook Event Send

curl --request GET \
  --url https://api.decodahealth.com/webhook/decoda/events/{webhook_delivery_attempt_id}/send \
  --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",
  "alertId": "<string>",
  "deliveredDate": "2023-11-07T05:31:56Z",
  "lastDeliveryAttemptDate": "2023-11-07T05:31:56Z",
  "lastDeliveryAttemptStatus": 123,
  "lastDeliveryAttemptError": "<string>"
}

GET

webhook

decoda

events

{webhook_delivery_attempt_id}

send

Webhook Event Send

curl --request GET \
  --url https://api.decodahealth.com/webhook/decoda/events/{webhook_delivery_attempt_id}/send \
  --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",
  "alertId": "<string>",
  "deliveredDate": "2023-11-07T05:31:56Z",
  "lastDeliveryAttemptDate": "2023-11-07T05:31:56Z",
  "lastDeliveryAttemptStatus": 123,
  "lastDeliveryAttemptError": "<string>"
}

Headers

TENANT

string

required

The tenant you are making this request on behalf of

API-KEY

string

required

Your api key

Path Parameters

webhook_delivery_attempt_id

string

required

Query Parameters

notify_failure

boolean

default:true

Notify the webhook owner via email if the event fails to deliver

Response

Successful Response

An Event in Decoda's system.

string

required

Unique identifier for the webhook delivery attempt.

type

enum<string>

required

The type of event.

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

The Alert's data associated with this WebhookDeliveryAttempt.

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

string

required

The unique identifier for the payment.

data.amount

integer

required

The total amount of the payment.

data.status

enum<string>

required

The current status of the payment.

Available options:

CANCELED,

CREATED,

FAILED,

IN_REVIEW,

PRESENTING,

PROCESSING,

SUCCEEDED

data.paymentMedium

string

required

The name of the payment medium.

data.createdDate

string<date-time>

required

The date and time the payment was created.

data.feeToPatient

integer

required

The fee charged to the patient for the transaction.

data.patientId

string | null

The ID of the patient associated with the payment.

data.payinId

string | null

The ID of the payin associated with the payment.

data.currency

string

default:USD

The currency in which the payment was made.

data.payinConfigId

string | null

The configuration ID for the payin.

data.paymentMethodId

string | null

The ID of the payment method used.

data.stripePaymentIntentId

string | null

Stripe's payment intent ID if used.

data.failedReason

string | null

Reason for payment failure if applicable.

data.updatedDate

string<date-time> | null

The date and time the payment was last updated.

data.fee

integer

default:0

The fee charged by the payment processor.

createdDate

string<date-time>

required

The date and time when the event was created.

alertId

string

required

The Alert's id associated with this WebhookDeliveryAttempt.

deliveredDate

string<date-time> | null

The date and time when the event was delivered.

lastDeliveryAttemptDate

string<date-time> | null

The date and time when the last delivery attempt was made.

lastDeliveryAttemptStatus

integer | null

The HTTP status of the last delivery attempt.

lastDeliveryAttemptError

string | null

The error message from the last delivery attempt, if any.

Webhook Event Get Webhook Events List

⌘I

Getting Started

API

Tenant

Webhook

Webhook Event Send

Headers

Path Parameters

Query Parameters

Response