HYhypertrack
Orders

Get Order Webhooks

API to fetch webhooks sent for an order

get/orders/{order_handle}/webhooks

Request

Path parameters

order_handlestring required

Query parameters

valuestring nullable

String representation to fetch webhooks for. It can be comma separated list, each itemin list can be one of assigned, started, first_eta, eta, eta_change, n_minutes_away, device_switched, disabled, enabled, updated, delayed, risk_updated, arrived, exited, completed, cancelled, worker_departed. eg. `?value=eta,eta_change

from_timestring nullable

ISO 8601 datetime indicating the start time to be used for fetching webhooks

to_timestring nullable

ISO 8601 datetime indicating the end time to be used for fetching webhooks

fulfillment_attemptinteger nullable

Filter for fulfillment attempt number

pagination_tokenstring nullable

Token provided by our API to retrieve the next page of webhooks

limitinteger nullable

Number of webhooks to be sent in response

sort_direction'desc' | 'asc' | 'null' nullable

Field to sort webhooks by time in ascending or descending order

debug_levelstring nullable

Hidden parameter to enable internal debug level logging for webhook queries

Response

Successful response

pagination_tokenstring nullable

Token to fetch next page of webhooks for the order

Changes

No recorded changes to this operation across all 1 revision of this API.