--- title: "Get Order Webhooks" method: GET path: "/orders/{order_handle}/webhooks" tags: ["Orders"] --- # Get Order Webhooks `GET /orders/{order_handle}/webhooks` ## Request - Base URL: `https://v3.api.hypertrack.com` - URL: `https://v3.api.hypertrack.com/orders/{order_handle}/webhooks` - Auth: one of: - HTTP basic - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) API to fetch webhooks sent for an order ## Path parameters - `order_handle` string, required ## Query parameters - `value` string, nullable - `from_time` string, nullable - `to_time` string, nullable - `fulfillment_attempt` integer, nullable - `pagination_token` string, nullable - `limit` integer, nullable - `sort_direction` 'desc' | 'asc' | 'null', nullable - `debug_level` string, nullable ## Response `200` Successful response - GetOrderWebhooksResponse - `webhooks` OrderWebhookEvent[], nullable: List of Webhooks sent for the order - `account_id` string, required: Unique Identifier for the account registered with HyperTrack - `recorded_at` string, required: Timestamp at which the order webhook event was recorded - `created_at` string, required: Timestamp at which the order webhook event was sent - `device_id` string, required: Unique identifier for a device - `worker_handle` string, nullable: Unique customer provided identifier for the worker - `driver_handle` string, nullable: Unique customer provided identifier for the worker - `type` 'order', required: Type of webhook. Here the value will be `order` - `location` union: Location of the worker at the time of order webhook event - PointLocationGeometryResponse - `type` 'Point', required: Point Geometry type - `coordinates` number[], required: Location coordinates represented as [longitude, latitude]. - unknown - `version` string, required: Version of the webhook event - `data` union, required: Object containing information specific to the value of the webhook - OrderAssignedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'assigned', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `assigned_at` string, required: Timestamp at which the order was assigned to a worker - OrderStartedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'started', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - OrderOnDeviceGeofenceCheckedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'on_device_geofence_checked', required: String representation type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `is_inside` boolean, required: Boolean representation of whether the worker was inside when he/she tried to clockin/clockout - `location_accuracy` integer, nullable: Accuracy of the location at the time of order webhook event - OrderFirstEtaWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'first_eta', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `remaining_duration` integer, required: Estimated remaining duration (in seconds) for worker to reach order destination - `remaining_distance` integer, required: Estimated remaining distance (in meters) for worker to travel to reach order destination - `estimated_route_id` string, nullable: Unique identifier for the estimated route associated with this ETA event - OrderEtaWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'eta', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `remaining_duration` integer, required: Estimated remaining duration (in seconds) for worker to reach order destination - `remaining_distance` integer, required: Estimated remaining distance (in meters) for worker to travel to reach order destination - `estimated_route_id` string, nullable: Unique identifier for the estimated route associated with this ETA event - `driver_location` union: Location used to calculate the reported ETA. Its device timestamp is provided in location_recorded_at. - PointLocationGeometryResponse - `type` 'Point', required: Point Geometry type - `coordinates` number[], required: Location coordinates represented as [longitude, latitude]. - unknown - `location_recorded_at` string, date-time, nullable: Device timestamp of driver_location, the location used to calculate the reported ETA. - `in_outage` boolean, nullable: Boolean flag whether worker is in outage or not at the time of order webhook event - `scheduled_at` string, nullable: Timestamp indicating the scheduled time of the order - OrderEtaChangeWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'eta_change', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `remaining_duration` integer, required: Estimated remaining duration (in seconds) for worker to reach order destination - `remaining_distance` integer, required: Estimated remaining distance (in meters) for worker to travel to reach order destination - `estimated_route_id` string, nullable: Unique identifier for the estimated route associated with this ETA event - `earliest_possible_arrival_time` string, nullable: Timestamp indicating the earliest possible arrival of the worker at the destination. - `change_reason` unknown - OrderNMinutesAwayWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'n_minutes_away', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `remaining_duration` integer, required: Estimated remaining duration (in seconds) for worker to reach order destination - `remaining_distance` integer, required: Estimated remaining distance (in meters) for worker to travel to reach order destination - `estimated_route_id` string, nullable: Unique identifier for the estimated route associated with this ETA event - `remaining_minutes` integer, required: Estimated remaining duration (in minutes) for worker to reach order destination - OrderDeviceSwitchedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'device_switched', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `previous_device_id` string, required: Unique identifier for a previously device linked with order - `new_device_id` string, required: Unique identifier for a new device linked with order - OrderDisabledWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'disabled', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - OrderEnabledWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'enabled', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - OrderUpdatedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'updated', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - OrderDelayedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'delayed', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `arrive_at` string, required: Estimated timestamp at which worker is expected to reach order destination - `scheduled_at` string, nullable: Timestamp indicating the scheduled time of the order - `initial_eta` string, nullable: Initial estimated time of arrival computed when order tracking was started - OrderRiskUpdatedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'risk_updated', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `risks` object, required: Risk information associated with the order at the time when order webhook was recorded - OrderArrivedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'arrived', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `place_handle` string, nullable: Unique identifier provided by the customer for a place - `scheduled_at` string, nullable: Timestamp indicating the scheduled time of the order - `initial_eta` string, nullable: Initial estimated time of arrival computed when order tracking was started - `arrival` WebhookArrivalData, required - `location` PointLocationGeometryResponse, required - `type` 'Point', required: Point Geometry type - `coordinates` number[], required: Location coordinates represented as [longitude, latitude]. - `recorded_at` string, required: Timestamp when worker arrived at the order destination - `location_accuracy` number, nullable: GPS accuracy in meters at time of arrival - OrderExitedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'exited', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `place_handle` string, nullable: Unique identifier provided by the customer for a place - `scheduled_at` string, nullable: Timestamp indicating the scheduled time of the order - `initial_eta` string, nullable: Initial estimated time of arrival computed when order tracking was started - `exit` WebhookExitData, required - `location` union: Location of the worker at the time of exit - PointLocationGeometryResponse - … - unknown - `recorded_at` string, required: Timestamp when worker exited from the order destination - `location_accuracy` number, nullable: GPS accuracy in meters at time of exit - `reason` unknown - OrderCompletedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'completed', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `distance` integer, nullable: Distance travelled (in meters) during the order - `duration` integer, required: Total duration (in seconds) of the order - `deviation` integer, nullable: Distance (in meters) between the actual completion location to the order destination - `actual_service_time` integer, nullable: Time (in seconds) that the worker spent at the order location when servicing the order - OrderCancelledWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'cancelled', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `distance` integer, nullable: Distance travelled (in meters) during the order - `duration` integer, required: Total duration (in seconds) of the order - `cancellation_reason` string, nullable: Customer-reported reason why the shift did not occur as planned: `no_show`, `worker_cancelled`, `client_cancelled`, `other`. Consumers must accept new values. - OrderBillingDetailsUpdatedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'billing_details_updated', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `billing_details` BillingConstituents, required - `travel_time` integer, required: Time spent traveling to the order destination. - `service_time` integer, required: Time spent servicing the order. - `over_time` integer, required: Time spent working beyond the expected finish time. - `arrival_delay` integer, required: Delay in arrival to the order destination beyond expected start time. - `post_shift_tracking_time` integer, required: Time spent tracking the worker post work completion. - `break_time` BillingBreakTimeModelFine[], nullable: List of breaktimes for the order. - `id` string, required: Unique identifier for the breaktime. - `ht_val` union: Hypertrack's inference for the breaktime. - … - `worker_val` union: Worker's assessment for the breaktime. - … - `facility_val` union: Facility's assessment for the breaktime. - … - `billable_hours` integer, required: Total billable hours computed for the order - OrderTaskCreatedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'task_created', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `task` OrderTaskResponse, required - `label` string, required: Type of task to be created for the order. - `task_definition_id` string, nullable: Id of the tasks definition from which this task is picked - `description` string, nullable: Description of the task type. - `metadata` object, nullable: Additional metadata for the task. - `priority` 'none' | 'low' | 'medium' | 'high' | 'null', nullable: Priority of the task. Valid values are none, low, medium, high. - `task_id` string, required: Unique identifier for the created task. - `status` string, nullable: Status of the task. Valid values are pending, ongoing, completed, cancelled. - `created_at` string, required: Timestamp when the task was created. - `updated_at` string, nullable: Timestamp when the task was last updated. - `attachments` union[], nullable: Attachments associated with the event - union - … - `scheduled_at` string, nullable: Timestamp indicating the scheduled time of the order - OrderTaskUpdatedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'task_updated', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `task` OrderTaskResponse, required - `label` string, required: Type of task to be created for the order. - `task_definition_id` string, nullable: Id of the tasks definition from which this task is picked - `description` string, nullable: Description of the task type. - `metadata` object, nullable: Additional metadata for the task. - `priority` 'none' | 'low' | 'medium' | 'high' | 'null', nullable: Priority of the task. Valid values are none, low, medium, high. - `task_id` string, required: Unique identifier for the created task. - `status` string, nullable: Status of the task. Valid values are pending, ongoing, completed, cancelled. - `created_at` string, required: Timestamp when the task was created. - `updated_at` string, nullable: Timestamp when the task was last updated. - `attachments` union[], nullable: Attachments associated with the event - union - … - `scheduled_at` string, nullable: Timestamp indicating the scheduled time of the order - OrderTaskCompletedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'task_completed', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `task` OrderTaskResponse, required - `label` string, required: Type of task to be created for the order. - `task_definition_id` string, nullable: Id of the tasks definition from which this task is picked - `description` string, nullable: Description of the task type. - `metadata` object, nullable: Additional metadata for the task. - `priority` 'none' | 'low' | 'medium' | 'high' | 'null', nullable: Priority of the task. Valid values are none, low, medium, high. - `task_id` string, required: Unique identifier for the created task. - `status` string, nullable: Status of the task. Valid values are pending, ongoing, completed, cancelled. - `created_at` string, required: Timestamp when the task was created. - `updated_at` string, nullable: Timestamp when the task was last updated. - `attachments` union[], nullable: Attachments associated with the event - union - … - `scheduled_at` string, nullable: Timestamp indicating the scheduled time of the order - OrderWorkerDepartedWebhookEventData - `order_handle` string, required: Unique handle of the order - `route_handle` string, required: Unique identifier for the route to which the order belongs - `value` 'worker_departed', required: String representing type of order webhook - `status` string, required: Status of the order at the time of webhook event - `share_url` string, nullable: Shareable URL for the consumer to track the live movement of the drive after the order is dispatched - `metadata` object, nullable: Additional customer provided information about the order - `departed_at` string, required: Timestamp at which the worker departed for the order - `start_by` string, nullable: Timestamp by which the worker was expected to start the order - `departure_location` union: Worker location at the departure anchor - PointLocationGeometryResponse - `type` 'Point', required: Point Geometry type - `coordinates` number[], required: Location coordinates represented as [longitude, latitude]. - unknown - `delivery_http_status` integer, nullable: HTTP status code returned by the customer endpoint when the webhook was delivered - `retry_count` integer, nullable: Number of delivery retries attempted for the webhook - `delivery_http_response_text` string, nullable: Response body returned by the customer endpoint when the webhook was delivered - `pagination_token` string, nullable: Token to fetch next page of webhooks for the order ## Other responses - `400`: Validation error - `401`: Authentication error - `404`: Not found --- [API](https://skmtc.dev/hypertrack/apis/hypertrack-api.md) - [All operations](https://skmtc.dev/hypertrack/apis/hypertrack-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hypertrack/apis/hypertrack-api/revisions/389326c4c9c8?raw)