Skip to main content
GET
/
v1
/
webhook
/
events
/
{webhook_delivery_attempt_id}
Webhook Event Get
curl --request GET \
  --url https://api.decodahealth.com/v1/webhook/events/{webhook_delivery_attempt_id} \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
{
  "alertId": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "data": {
    "amount": 123,
    "createdDate": "2023-11-07T05:31:56Z",
    "currency": "USD",
    "failedReason": "<string>",
    "fee": 123,
    "id": "<string>",
    "patientId": "<string>",
    "payinConfigId": "<string>",
    "payinId": "<string>",
    "paymentMedium": "POS",
    "paymentMethodId": "<string>",
    "status": "CANCELED",
    "stripePaymentIntentId": "<string>",
    "updatedDate": "2023-11-07T05:31:56Z"
  },
  "deliveredDate": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "lastDeliveryAttemptDate": "2023-11-07T05:31:56Z",
  "lastDeliveryAttemptError": "<string>",
  "lastDeliveryAttemptStatus": 123,
  "type": "PATIENT_CREATED"
}

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

Response

Successful Response

An Event in Decoda's system.

​
alertId
string
required

The Alert's id associated with this WebhookDeliveryAttempt.

​
createdDate
string<date-time>
required

The date and time when the event was created.

​
data
object
required

The Alert's data associated with this WebhookDeliveryAttempt.

  • Payment
  • RefundSummary
  • AdjustmentSummary
  • ChargeSummary
  • AppointmentDetail
  • MessageSummary
  • Payment
  • PatientSummary
​
id
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_RESCHEDULED,
APPOINTMENT_REQUEST,
PAYMENT_CREATED,
PAYMENT_FAILED,
PAYMENT_SUCCEEDED,
CHARGE_CREATED,
REFUND_CREATED,
REFUND_FAILED,
REFUND_SUCCEEDED,
ADJUSTMENT_CREATED,
ADJUSTMENT_FAILED,
ADJUSTMENT_SUCCEEDED,
INVOICE_SENT,
INVOICE_FAILED,
CALL_RECEIVED,
CALL_MADE,
MESSAGE_RECIEVED,
MESSAGE_SENT,
MESSAGE_DELIVERED,
MESSAGE_FAILED,
EMAIL_RECIEVED,
EMAIL_SENT,
FORM_SUBMITTED,
MAIL_SENT,
MAIL_DELIVERY_FAILED
​
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.

​
lastDeliveryAttemptError
string | null

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

​
lastDeliveryAttemptStatus
integer | null

The HTTP status of the last delivery attempt.

⌘I