DEdecodahealth
webhook

Webhook Events List

List and search for attempts to deliver Events for a particular Webhook (i.e. WebhookDeliveryAttempts).

get/webhook/decoda/{webhook_id}/delivery-attempts/list

Request

Path parameters

webhook_idstring required

Query parameters

event_type'PAYMENT_CREATED' | 'PAYMENT_COMPLETED' | 'PAYMENT_FAILED' | 'CHARGE_CREATED' | 'ADJUSTMENT_CREATED' | 'REFUND_CREATED' | 'PATIENT_CREATED' | 'PATIENT_UPDATED'

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

The type of event to filter by

is_deliveredboolean nullable

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

created_beforestring date-time nullable

Get Events created before this date

created_afterstring date-time nullable

Get Events created after this date

last_delivery_attempt_statusstring nullable

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

last_delivery_attempt_errorstring nullable

Filter by the error message of the most recent delivery attempt

delivery_date_beforestring date-time nullable

Get Events with a delivery date before this date

delivery_date_afterstring date-time nullable

Get Events with a delivery date after this date

sort_bystring nullable

The field to sort by

sort_direction'asc' | 'desc' nullable

The direction to sort by

limitinteger nullable

The maximum number of results to return

offsetinteger nullable

The number of results to skip at the beginning

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Response

Successful Response

idstring required

Unique identifier for the webhook delivery attempt.

type'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' | 'APPOINTMENT_CHECKLIST_FILLED_FORM' | 'APPOINTMENT_CHECKLIST_CHECKED_IN' | 'APPOINTMENT_CHECKLIST_WITH_MA' | 'APPOINTMENT_CHECKLIST_MEASUREMENT_TAKEN' | 'APPOINTMENT_CHECKLIST_DOSE_TAKEN' | 'APPOINTMENT_CHECKLIST_WITH_PROVIDER' | 'APPOINTMENT_CHECKLIST_NOTE_TAKEN' | 'APPOINTMENT_CHECKLIST_PAYMENT_MADE' | 'APPOINTMENT_CHECKLIST_REQUEST_GFE' | 'APPOINTMENT_CHECKLIST_PICTURE_TAKEN' | 'APPOINTMENT_CHECKLIST_CARE_PLAN' | 'NOTIFICATION' | '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' required
createdDatestring date-time required

The date and time when the event was created.

alertIdstring required

The Alert's id associated with this WebhookDeliveryAttempt.

deliveredDatestring date-time nullable

The date and time when the event was delivered.

lastDeliveryAttemptDatestring date-time nullable

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

lastDeliveryAttemptStatusinteger nullable

The HTTP status of the last delivery attempt.

lastDeliveryAttemptErrorstring nullable

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

Changes

No recorded changes to this operation across all 2 revisions of this API.