GET
/
v1
/
webhook
/
{webhook_id}
/
delivery-attempts
/
list

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

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 | null

Get Events created before this date

created_after
string | 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 | null

Get Events with a delivery date before this date

delivery_date_after
string | 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

200 - application/json
alertId
string
required

The Alert's id associated with this WebhookDeliveryAttempt.

createdDate
string
required

The date and time when the event was created.

data
object
required

The Alert's data associated with this WebhookDeliveryAttempt.

deliveredDate
string | null

The date and time when the event was delivered.

id
string
required

Unique identifier for the webhook delivery attempt.

lastDeliveryAttemptDate
string | 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.

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_RECIEVED,
CALL_MADE,
MESSAGE_RECIEVED,
MESSAGE_SENT,
MESSAGE_DELIVERED,
MESSAGE_FAILED,
EMAIL_RECIEVED,
EMAIL_SENT,
FORM_SUBMITTED,
MAIL_SENT,
MAIL_DELIVERY_FAILED
Webhook Event SendLink 2500