Skip to main content
GET
/
v1
/
webhook
/
{webhook_id}
/
delivery-attempts
/
list
Webhook Events List
curl --request GET \
  --url https://api.decodahealth.com/v1/webhook/{webhook_id}/delivery-attempts/list \
  --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_id
string
required

Query Parameters

​
event_type
enum<string> | null

The type of event to filter by WebhookEventType is an enum that represents the type of event that will be sent to the webhook.

Available options:
PAYMENT_CREATED,
PAYMENT_COMPLETED,
PAYMENT_FAILED,
CHARGE_CREATED,
ADJUSTMENT_CREATED,
REFUND_CREATED,
PATIENT_CREATED,
PATIENT_UPDATED
​
is_delivered
boolean | null

Filter by if the event has not been delivered (i.e. we have not recieved a 200 from you for this event.)

​
created_before
string<date-time> | null

Get Events created before this date

​
created_after
string<date-time> | null

Get Events created after this date

​
last_delivery_attempt_status
string | null

Filter by the HTTP status of the most recent delivery attempt (i.e. 200, 404, 500, etc.)

​
last_delivery_attempt_error
string | null

Filter by the error message of the most recent delivery attempt

​
delivery_date_before
string<date-time> | null

Get Events with a delivery date before this date

​
delivery_date_after
string<date-time> | null

Get Events with a delivery date after this date

​
sort_by
string | null
default:created_date

The field to sort by

​
sort_direction
enum<string> | null
default:desc

The direction to sort by

Available options:
asc,
desc
​
limit
integer | null
default:10

The maximum number of results to return

​
offset
integer | null
default:0

The number of results to skip at the beginning

Response

Successful Response

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