{ "asyncapi": "3.0.0", "id": "urn:superroute:webhooks", "info": { "title": "Superroute outbound webhooks", "version": "1.5.2", "description": "Every event Superroute sends to a receiver over HTTP. Each sender has its own headers, signature recipe and retry schedule; see `x-superroute-senders` and each message's `x-superroute-retry`. Schemas are descriptive: objects may carry fields that are not listed, and new fields can appear at any time, so do not reject unknown fields.", "tags": [ { "name": "tenant", "description": "Tenant webhooks" }, { "name": "partner-locker", "description": "Partner locker deliveries" }, { "name": "tpd", "description": "Third-party delivery assignments" }, { "name": "loading-plan", "description": "Loading plan callbacks" }, { "name": "open-platform", "description": "Open Platform job callbacks" }, { "name": "ohp", "description": "OHP push" }, { "name": "dataset", "description": "Dataset webhooks" } ] }, "defaultContentType": "application/json", "channels": { "tenant.order_create_webhook_url": { "address": null, "title": "Tenant webhooks — order_create_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `order_create_webhook_url`.", "messages": { "order.created": { "$ref": "#/components/messages/tenant.order.created" } } }, "tenant.order_status_change_webhook_url": { "address": null, "title": "Tenant webhooks — order_status_change_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `order_status_change_webhook_url`.", "messages": { "order.status_change": { "$ref": "#/components/messages/tenant.order.status_change" } } }, "tenant.tracking_event_webhook_url": { "address": null, "title": "Tenant webhooks — tracking_event_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `tracking_event_webhook_url`.", "messages": { "tracking.event": { "$ref": "#/components/messages/tenant.tracking.event" } } }, "tenant.order_create_async_postback_url": { "address": null, "title": "Tenant webhooks — order_create_async_postback_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `order_create_async_postback_url`.", "messages": { "order.create_async": { "$ref": "#/components/messages/tenant.order.create_async" } } }, "tenant.pod_files_webhook_url": { "address": null, "title": "Tenant webhooks — pod_files_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `pod_files_webhook_url`.", "messages": { "pod.files_updated": { "$ref": "#/components/messages/tenant.pod.files_updated" } } }, "tenant.order_deleted_webhook_url": { "address": null, "title": "Tenant webhooks — order_deleted_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `order_deleted_webhook_url`.", "messages": { "order.deleted": { "$ref": "#/components/messages/tenant.order.deleted" } } }, "tenant.order_cancel_failed_webhook_url": { "address": null, "title": "Tenant webhooks — order_cancel_failed_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `order_cancel_failed_webhook_url`.", "messages": { "order.cancel_failed": { "$ref": "#/components/messages/tenant.order.cancel_failed" } } }, "tenant.route_board_webhook_url": { "address": null, "title": "Tenant webhooks — route_board_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `route_board_webhook_url`.", "messages": { "route_board.seat_changed": { "$ref": "#/components/messages/tenant.route_board.seat_changed" } } }, "tenant.order_lifecycle_webhook_url": { "address": null, "title": "Tenant webhooks — order_lifecycle_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `order_lifecycle_webhook_url`.", "messages": { "order.assigned": { "$ref": "#/components/messages/tenant.order.assigned" }, "order.unassigned": { "$ref": "#/components/messages/tenant.order.unassigned" }, "order.accepted": { "$ref": "#/components/messages/tenant.order.accepted" }, "order.rejected": { "$ref": "#/components/messages/tenant.order.rejected" }, "order.pickup_started": { "$ref": "#/components/messages/tenant.order.pickup_started" }, "order.picked_up": { "$ref": "#/components/messages/tenant.order.picked_up" }, "order.on_the_way": { "$ref": "#/components/messages/tenant.order.on_the_way" }, "order.completed": { "$ref": "#/components/messages/tenant.order.completed" }, "order.failed": { "$ref": "#/components/messages/tenant.order.failed" }, "order.cancelled": { "$ref": "#/components/messages/tenant.order.cancelled" }, "order.ready": { "$ref": "#/components/messages/tenant.order.ready" }, "driver.on_duty_changed": { "$ref": "#/components/messages/tenant.driver.on_duty_changed" } } }, "tenant.driver_location_webhook_url": { "address": null, "title": "Tenant webhooks — driver_location_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `driver_location_webhook_url`.", "messages": { "driver.location_update": { "$ref": "#/components/messages/tenant.driver.location_update" } } }, "tenant.device_order_webhook_url": { "address": null, "title": "Tenant webhooks — device_order_webhook_url", "description": "Delivered by HTTP POST to the receiver's URL. Configured in the recipient's webhook setting `device_order_webhook_url`.", "messages": { "device_order.stored": { "$ref": "#/components/messages/tenant.device_order.stored" }, "device_order.collected": { "$ref": "#/components/messages/tenant.device_order.collected" }, "device_order.removed": { "$ref": "#/components/messages/tenant.device_order.removed" }, "device_order.overdue": { "$ref": "#/components/messages/tenant.device_order.overdue" }, "device_order.exception_opened": { "$ref": "#/components/messages/tenant.device_order.exception_opened" }, "device_order.exception_resolved": { "$ref": "#/components/messages/tenant.device_order.exception_resolved" } } }, "partner-locker.endpoint": { "address": null, "title": "Partner locker deliveries — partner_locker.delivery_doors_opened", "description": "Delivered by HTTP POST to the receiver's URL. Configured on the provider's webhook endpoint; the endpoint's event types select what is sent.", "messages": { "partner_locker.delivery.doors_opened": { "$ref": "#/components/messages/partner-locker.partner_locker.delivery.doors_opened" }, "partner_locker.delivery.delivered": { "$ref": "#/components/messages/partner-locker.partner_locker.delivery.delivered" }, "partner_locker.pickup.completed": { "$ref": "#/components/messages/partner-locker.partner_locker.pickup.completed" }, "partner_locker.delivery.failed": { "$ref": "#/components/messages/partner-locker.partner_locker.delivery.failed" }, "partner_locker.delivery.expired": { "$ref": "#/components/messages/partner-locker.partner_locker.delivery.expired" }, "partner_locker.delivery.cancelled": { "$ref": "#/components/messages/partner-locker.partner_locker.delivery.cancelled" }, "partner_locker.delivery.correction_reopened": { "$ref": "#/components/messages/partner-locker.partner_locker.delivery.correction_reopened" }, "partner_locker.delivery.code_rotated": { "$ref": "#/components/messages/partner-locker.partner_locker.delivery.code_rotated" }, "carrier_package.distribution.created": { "$ref": "#/components/messages/partner-locker.carrier_package.distribution.created" }, "carrier_package.distribution.loaded": { "$ref": "#/components/messages/partner-locker.carrier_package.distribution.loaded" }, "carrier_package.distribution.delivered": { "$ref": "#/components/messages/partner-locker.carrier_package.distribution.delivered" }, "carrier_package.distribution.shelved": { "$ref": "#/components/messages/partner-locker.carrier_package.distribution.shelved" }, "carrier_package.distribution.removed": { "$ref": "#/components/messages/partner-locker.carrier_package.distribution.removed" } } }, "tpd.endpoint": { "address": null, "title": "Third-party delivery assignments — delivery.assignment.created", "description": "Delivered by HTTP POST to the receiver's URL. Configured on the provider's webhook endpoint; the endpoint's event types select what is sent.", "messages": { "delivery.assignment.created": { "$ref": "#/components/messages/tpd.delivery.assignment.created" }, "delivery.assignment.handed_over": { "$ref": "#/components/messages/tpd.delivery.assignment.handed_over" }, "delivery.assignment.cancelled": { "$ref": "#/components/messages/tpd.delivery.assignment.cancelled" }, "delivery.assignment.partial_delivered": { "$ref": "#/components/messages/tpd.delivery.assignment.partial_delivered" } } }, "loading-plan.callback": { "address": null, "title": "Loading plan callbacks — callback_url", "description": "Delivered by HTTP POST to the receiver's URL. The `callback_url` of the solve request.", "messages": { "loading_plan.solve_started": { "$ref": "#/components/messages/loading-plan.loading_plan.solve_started" }, "loading_plan.candidates_ready": { "$ref": "#/components/messages/loading-plan.loading_plan.candidates_ready" }, "loading_plan.finalized": { "$ref": "#/components/messages/loading-plan.loading_plan.finalized" }, "loading_plan.validation_failed": { "$ref": "#/components/messages/loading-plan.loading_plan.validation_failed" }, "loading_plan.solve_failed": { "$ref": "#/components/messages/loading-plan.loading_plan.solve_failed" }, "loading_plan.cancelled": { "$ref": "#/components/messages/loading-plan.loading_plan.cancelled" } } }, "open-platform.callback": { "address": null, "title": "Open Platform job callbacks — callback.url", "description": "Delivered by HTTP POST to the receiver's URL. The `callback.url` of the job request.", "messages": { "endpoint.verify": { "$ref": "#/components/messages/open-platform.endpoint.verify" }, "job.queued": { "$ref": "#/components/messages/open-platform.job.queued" }, "job.succeeded": { "$ref": "#/components/messages/open-platform.job.succeeded" }, "job.failed": { "$ref": "#/components/messages/open-platform.job.failed" }, "job.cancelled": { "$ref": "#/components/messages/open-platform.job.cancelled" } } }, "ohp.push": { "address": null, "title": "OHP push — POST /api/v1/ohp/subscriptions `events`", "description": "Delivered by HTTP POST to the receiver's URL. ", "messages": { "subscription.verify": { "$ref": "#/components/messages/ohp.subscription.verify" }, "handoff.accepted": { "$ref": "#/components/messages/ohp.handoff.accepted" }, "handoff.rejected": { "$ref": "#/components/messages/ohp.handoff.rejected" }, "handoff.expired": { "$ref": "#/components/messages/ohp.handoff.expired" }, "handoff.cancelled": { "$ref": "#/components/messages/ohp.handoff.cancelled" }, "amendment.accepted": { "$ref": "#/components/messages/ohp.amendment.accepted" }, "amendment.rejected": { "$ref": "#/components/messages/ohp.amendment.rejected" }, "handoff.tracking": { "$ref": "#/components/messages/ohp.handoff.tracking" }, "settlement_line.created": { "$ref": "#/components/messages/ohp.settlement_line.created" } } }, "dataset.webhook": { "address": null, "title": "Dataset webhooks — url", "description": "Delivered by HTTP POST to the receiver's URL. The dataset webhook's URL.", "messages": { "test": { "$ref": "#/components/messages/dataset.test" }, "record_created": { "$ref": "#/components/messages/dataset.record_created" }, "record_updated": { "$ref": "#/components/messages/dataset.record_updated" }, "record_deleted": { "$ref": "#/components/messages/dataset.record_deleted" }, "import_completed": { "$ref": "#/components/messages/dataset.import_completed" }, "geocode_completed": { "$ref": "#/components/messages/dataset.geocode_completed" }, "validation_failed": { "$ref": "#/components/messages/dataset.validation_failed" }, "duplicate_found": { "$ref": "#/components/messages/dataset.duplicate_found" } } } }, "operations": { "tenant.order_create_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.order_create_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.order_create_webhook_url/messages/order.created" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.order_status_change_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.order_status_change_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.order_status_change_webhook_url/messages/order.status_change" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.tracking_event_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.tracking_event_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.tracking_event_webhook_url/messages/tracking.event" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.order_create_async_postback_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.order_create_async_postback_url" }, "messages": [ { "$ref": "#/channels/tenant.order_create_async_postback_url/messages/order.create_async" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.pod_files_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.pod_files_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.pod_files_webhook_url/messages/pod.files_updated" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.order_deleted_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.order_deleted_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.order_deleted_webhook_url/messages/order.deleted" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.order_cancel_failed_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.order_cancel_failed_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.order_cancel_failed_webhook_url/messages/order.cancel_failed" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.route_board_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.route_board_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.route_board_webhook_url/messages/route_board.seat_changed" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.order_lifecycle_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.order_lifecycle_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.assigned" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.unassigned" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.accepted" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.rejected" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.pickup_started" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.picked_up" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.on_the_way" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.completed" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.failed" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.cancelled" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/order.ready" }, { "$ref": "#/channels/tenant.order_lifecycle_webhook_url/messages/driver.on_duty_changed" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.driver_location_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.driver_location_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.driver_location_webhook_url/messages/driver.location_update" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tenant.device_order_webhook_url.send": { "action": "send", "channel": { "$ref": "#/channels/tenant.device_order_webhook_url" }, "messages": [ { "$ref": "#/channels/tenant.device_order_webhook_url/messages/device_order.stored" }, { "$ref": "#/channels/tenant.device_order_webhook_url/messages/device_order.collected" }, { "$ref": "#/channels/tenant.device_order_webhook_url/messages/device_order.removed" }, { "$ref": "#/channels/tenant.device_order_webhook_url/messages/device_order.overdue" }, { "$ref": "#/channels/tenant.device_order_webhook_url/messages/device_order.exception_opened" }, { "$ref": "#/channels/tenant.device_order_webhook_url/messages/device_order.exception_resolved" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "partner-locker.endpoint.send": { "action": "send", "channel": { "$ref": "#/channels/partner-locker.endpoint" }, "messages": [ { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.delivery.doors_opened" }, { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.delivery.delivered" }, { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.pickup.completed" }, { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.delivery.failed" }, { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.delivery.expired" }, { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.delivery.cancelled" }, { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.delivery.correction_reopened" }, { "$ref": "#/channels/partner-locker.endpoint/messages/partner_locker.delivery.code_rotated" }, { "$ref": "#/channels/partner-locker.endpoint/messages/carrier_package.distribution.created" }, { "$ref": "#/channels/partner-locker.endpoint/messages/carrier_package.distribution.loaded" }, { "$ref": "#/channels/partner-locker.endpoint/messages/carrier_package.distribution.delivered" }, { "$ref": "#/channels/partner-locker.endpoint/messages/carrier_package.distribution.shelved" }, { "$ref": "#/channels/partner-locker.endpoint/messages/carrier_package.distribution.removed" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "tpd.endpoint.send": { "action": "send", "channel": { "$ref": "#/channels/tpd.endpoint" }, "messages": [ { "$ref": "#/channels/tpd.endpoint/messages/delivery.assignment.created" }, { "$ref": "#/channels/tpd.endpoint/messages/delivery.assignment.handed_over" }, { "$ref": "#/channels/tpd.endpoint/messages/delivery.assignment.cancelled" }, { "$ref": "#/channels/tpd.endpoint/messages/delivery.assignment.partial_delivered" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "loading-plan.callback.send": { "action": "send", "channel": { "$ref": "#/channels/loading-plan.callback" }, "messages": [ { "$ref": "#/channels/loading-plan.callback/messages/loading_plan.solve_started" }, { "$ref": "#/channels/loading-plan.callback/messages/loading_plan.candidates_ready" }, { "$ref": "#/channels/loading-plan.callback/messages/loading_plan.finalized" }, { "$ref": "#/channels/loading-plan.callback/messages/loading_plan.validation_failed" }, { "$ref": "#/channels/loading-plan.callback/messages/loading_plan.solve_failed" }, { "$ref": "#/channels/loading-plan.callback/messages/loading_plan.cancelled" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "open-platform.callback.send": { "action": "send", "channel": { "$ref": "#/channels/open-platform.callback" }, "messages": [ { "$ref": "#/channels/open-platform.callback/messages/endpoint.verify" }, { "$ref": "#/channels/open-platform.callback/messages/job.queued" }, { "$ref": "#/channels/open-platform.callback/messages/job.succeeded" }, { "$ref": "#/channels/open-platform.callback/messages/job.failed" }, { "$ref": "#/channels/open-platform.callback/messages/job.cancelled" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "ohp.push.send": { "action": "send", "channel": { "$ref": "#/channels/ohp.push" }, "messages": [ { "$ref": "#/channels/ohp.push/messages/subscription.verify" }, { "$ref": "#/channels/ohp.push/messages/handoff.accepted" }, { "$ref": "#/channels/ohp.push/messages/handoff.rejected" }, { "$ref": "#/channels/ohp.push/messages/handoff.expired" }, { "$ref": "#/channels/ohp.push/messages/handoff.cancelled" }, { "$ref": "#/channels/ohp.push/messages/amendment.accepted" }, { "$ref": "#/channels/ohp.push/messages/amendment.rejected" }, { "$ref": "#/channels/ohp.push/messages/handoff.tracking" }, { "$ref": "#/channels/ohp.push/messages/settlement_line.created" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } }, "dataset.webhook.send": { "action": "send", "channel": { "$ref": "#/channels/dataset.webhook" }, "messages": [ { "$ref": "#/channels/dataset.webhook/messages/test" }, { "$ref": "#/channels/dataset.webhook/messages/record_created" }, { "$ref": "#/channels/dataset.webhook/messages/record_updated" }, { "$ref": "#/channels/dataset.webhook/messages/record_deleted" }, { "$ref": "#/channels/dataset.webhook/messages/import_completed" }, { "$ref": "#/channels/dataset.webhook/messages/geocode_completed" }, { "$ref": "#/channels/dataset.webhook/messages/validation_failed" }, { "$ref": "#/channels/dataset.webhook/messages/duplicate_found" } ], "bindings": { "http": { "method": "POST", "bindingVersion": "0.3.0" } } } }, "components": { "schemas": { "headers.tenant": { "type": "object", "properties": { "Content-Type": { "type": "string", "description": "`application/json`; `application/cloudevents+json` for a URL set to `ce_structured`." }, "Signature": { "type": "string", "description": "Hex HMAC-SHA256 of the raw body, keyed with the recipient's `webhook_sign_secret`." }, "X-Webhook-Event-Id": { "type": "string", "description": "UUID identifying this send; the same on every retry of it. A manual redelivery gets a new one." }, "X-Webhook-Timestamp": { "type": "string", "description": "Unix seconds when the event was first dispatched. Retries repeat the same value." }, "X-Webhook-Signature-V2": { "type": "string", "description": "Hex HMAC-SHA256 of `\"{X-Webhook-Timestamp}.{raw body}\"`, same secret." }, "ce-specversion": { "type": "string", "description": "`1.0`. CloudEvents binary mode (`ce_binary`) only. (Not always sent.)" }, "ce-id": { "type": "string", "description": "The body's own `event_id` when it carries one, else X-Webhook-Event-Id. `ce_binary` only. (Not always sent.)" }, "ce-source": { "type": "string", "description": "`{app url}/webhook-sources/tenant/{business id}`; names the business also for deliveries to its customers. `ce_binary` only. (Not always sent.)" }, "ce-type": { "type": "string", "description": "`ca.superroute.` + the event type. `ce_binary` only. (Not always sent.)" }, "ce-subject": { "type": "string", "description": "`{reference type}/{reference id}`, e.g. `order/1001`, when the event has one. `ce_binary` only. (Not always sent.)" }, "ce-time": { "type": "string", "description": "RFC 3339 time of the event. `ce_binary` only. (Not always sent.)" }, "ce-dataschema": { "type": "string", "description": "URL of this message's payload schema in this document. `ce_binary` only. (Not always sent.)" }, "ce-srbusiness": { "type": "string", "description": "Id of the business. `ce_binary` only. (Not always sent.)" }, "ce-srattempt": { "type": "string", "description": "Delivery attempt number, starting at 1. `ce_binary` only. (Not always sent.)" }, "webhook-id": { "type": "string", "description": "Standard Webhooks v1 id; same value as ce-id. `standard_webhooks` only. (Not always sent.)" }, "webhook-timestamp": { "type": "string", "description": "Unix seconds of this attempt; set again on every retry. `standard_webhooks` only. (Not always sent.)" }, "webhook-signature": { "type": "string", "description": "`v1,` + base64 HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"`, keyed with `webhook_sign_secret` (`whsec_` + base64 of it for Standard Webhooks libraries). `standard_webhooks` only. (Not always sent.)" } }, "required": [ "Content-Type", "Signature", "X-Webhook-Event-Id", "X-Webhook-Timestamp", "X-Webhook-Signature-V2" ], "additionalProperties": true }, "headers.partner-locker": { "type": "object", "properties": { "Content-Type": { "type": "string", "description": "`application/json`; `application/cloudevents+json` for an endpoint set to `ce_structured`." }, "X-Webhook-Id": { "type": "string", "description": "The event id (`event_id` in the body); the same on every retry." }, "X-Webhook-Delivery-Id": { "type": "string", "description": "UUID of this delivery attempt; different on every attempt." }, "X-Webhook-Timestamp": { "type": "string", "description": "Unix seconds of this attempt." }, "X-Webhook-Key-Id": { "type": "string", "description": "Id of the signing key used." }, "X-Webhook-Content-Digest": { "type": "string", "description": "`sha256=` + base64 SHA-256 of the raw body." }, "X-Webhook-Signature": { "type": "string", "description": "`v1=` + base64 HMAC-SHA256 of `\"{timestamp}\\n{delivery id}\\n{raw body}\"` with the endpoint's current signing secret. After a key rotation only the new key signs." }, "X-Webhook-Test": { "type": "string", "description": "`1` on sandbox (mock) events. (Not always sent.)" }, "ce-specversion": { "type": "string", "description": "`1.0`. CloudEvents binary mode (`ce_binary`) only. (Not always sent.)" }, "ce-id": { "type": "string", "description": "The event id (`event_id` in the body). `ce_binary` only. (Not always sent.)" }, "ce-source": { "type": "string", "description": "`{app url}/webhook-sources/{sender}/{business id}`, naming the business that sends the event. `ce_binary` only. (Not always sent.)" }, "ce-type": { "type": "string", "description": "`ca.superroute.` + the event type. `ce_binary` only. (Not always sent.)" }, "ce-subject": { "type": "string", "description": "`partner_locker_delivery/{delivery_no}`, `carrier_package/{package_no}` or `assignment/{assignment_no}`. `ce_binary` only. (Not always sent.)" }, "ce-time": { "type": "string", "description": "RFC 3339 time of the event. `ce_binary` only. (Not always sent.)" }, "ce-dataschema": { "type": "string", "description": "URL of this message's payload schema in this document. `ce_binary` only. (Not always sent.)" }, "ce-srbusiness": { "type": "string", "description": "Id of the sending business. `ce_binary` only. (Not always sent.)" }, "ce-srattempt": { "type": "string", "description": "Delivery attempt number, starting at 1. `ce_binary` only. (Not always sent.)" }, "webhook-id": { "type": "string", "description": "Standard Webhooks v1 id; same value as ce-id. `standard_webhooks` only. (Not always sent.)" }, "webhook-timestamp": { "type": "string", "description": "Same value as X-Webhook-Timestamp. `standard_webhooks` only. (Not always sent.)" }, "webhook-signature": { "type": "string", "description": "`v1,` + base64 HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with the signing secret (`whsec_` + base64 of it for Standard Webhooks libraries). For 24 hours after a key rotation it lists two space-separated signatures, new key first. `standard_webhooks` only. (Not always sent.)" } }, "required": [ "Content-Type", "X-Webhook-Id", "X-Webhook-Delivery-Id", "X-Webhook-Timestamp", "X-Webhook-Key-Id", "X-Webhook-Content-Digest", "X-Webhook-Signature" ], "additionalProperties": true }, "headers.tpd": { "type": "object", "properties": { "Content-Type": { "type": "string", "description": "`application/json`; `application/cloudevents+json` for an endpoint set to `ce_structured`." }, "X-Webhook-Id": { "type": "string", "description": "The event id (`event_id` in the body); the same on every retry." }, "X-Webhook-Delivery-Id": { "type": "string", "description": "UUID of this delivery attempt; different on every attempt." }, "X-Webhook-Timestamp": { "type": "string", "description": "Unix seconds of this attempt." }, "X-Webhook-Key-Id": { "type": "string", "description": "Id of the signing key used." }, "X-Webhook-Content-Digest": { "type": "string", "description": "`sha256=` + base64 SHA-256 of the raw body." }, "X-Webhook-Signature": { "type": "string", "description": "`v1=` + base64 HMAC-SHA256 of `\"{timestamp}\\n{delivery id}\\n{raw body}\"` with the endpoint's current signing secret. After a key rotation only the new key signs." }, "ce-specversion": { "type": "string", "description": "`1.0`. CloudEvents binary mode (`ce_binary`) only. (Not always sent.)" }, "ce-id": { "type": "string", "description": "The event id (`event_id` in the body). `ce_binary` only. (Not always sent.)" }, "ce-source": { "type": "string", "description": "`{app url}/webhook-sources/{sender}/{business id}`, naming the business that sends the event. `ce_binary` only. (Not always sent.)" }, "ce-type": { "type": "string", "description": "`ca.superroute.` + the event type. `ce_binary` only. (Not always sent.)" }, "ce-subject": { "type": "string", "description": "`partner_locker_delivery/{delivery_no}`, `carrier_package/{package_no}` or `assignment/{assignment_no}`. `ce_binary` only. (Not always sent.)" }, "ce-time": { "type": "string", "description": "RFC 3339 time of the event. `ce_binary` only. (Not always sent.)" }, "ce-dataschema": { "type": "string", "description": "URL of this message's payload schema in this document. `ce_binary` only. (Not always sent.)" }, "ce-srbusiness": { "type": "string", "description": "Id of the sending business. `ce_binary` only. (Not always sent.)" }, "ce-srattempt": { "type": "string", "description": "Delivery attempt number, starting at 1. `ce_binary` only. (Not always sent.)" }, "webhook-id": { "type": "string", "description": "Standard Webhooks v1 id; same value as ce-id. `standard_webhooks` only. (Not always sent.)" }, "webhook-timestamp": { "type": "string", "description": "Same value as X-Webhook-Timestamp. `standard_webhooks` only. (Not always sent.)" }, "webhook-signature": { "type": "string", "description": "`v1,` + base64 HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with the signing secret (`whsec_` + base64 of it for Standard Webhooks libraries). For 24 hours after a key rotation it lists two space-separated signatures, new key first. `standard_webhooks` only. (Not always sent.)" } }, "required": [ "Content-Type", "X-Webhook-Id", "X-Webhook-Delivery-Id", "X-Webhook-Timestamp", "X-Webhook-Key-Id", "X-Webhook-Content-Digest", "X-Webhook-Signature" ], "additionalProperties": true }, "headers.loading-plan": { "type": "object", "properties": { "Content-Type": { "type": "string", "description": "`application/json`." }, "X-Webhook-Event-Id": { "type": "string", "description": "The event id (`event_id` in the body); the same on every retry." }, "X-Webhook-Event-Type": { "type": "string", "description": "The event type." }, "X-Webhook-Timestamp": { "type": "string", "description": "Unix seconds of this attempt." }, "X-Webhook-Signature": { "type": "string", "description": "`v1=` + hex HMAC-SHA256 of `\"{timestamp}.{raw body}\"` with the run's `callback_secret`." }, "ce-specversion": { "type": "string", "description": "`1.0`. CloudEvents binary mode (`ce_binary`) only. (Not always sent.)" }, "ce-id": { "type": "string", "description": "The event id (`event_id` in the body). `ce_binary` only. (Not always sent.)" }, "ce-source": { "type": "string", "description": "`{app url}/webhook-sources/{sender}/{business id}`, naming the business that sends the event. `ce_binary` only. (Not always sent.)" }, "ce-type": { "type": "string", "description": "`ca.superroute.` + the event type. `ce_binary` only. (Not always sent.)" }, "ce-subject": { "type": "string", "description": "`solve_run/{solve_run_id}`. `ce_binary` only. (Not always sent.)" }, "ce-time": { "type": "string", "description": "RFC 3339 time of the event. `ce_binary` only. (Not always sent.)" }, "ce-dataschema": { "type": "string", "description": "URL of this message's payload schema in this document. `ce_binary` only. (Not always sent.)" }, "ce-srbusiness": { "type": "string", "description": "Id of the sending business. `ce_binary` only. (Not always sent.)" }, "ce-srattempt": { "type": "string", "description": "Delivery attempt number, starting at 1. `ce_binary` only. (Not always sent.)" }, "webhook-id": { "type": "string", "description": "Standard Webhooks v1 id; same value as ce-id. `standard_webhooks` only. (Not always sent.)" }, "webhook-timestamp": { "type": "string", "description": "Same value as X-Webhook-Timestamp. `standard_webhooks` only. (Not always sent.)" }, "webhook-signature": { "type": "string", "description": "`v1,` + base64 HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with the run's `callback_secret` (`whsec_` + base64 of it for Standard Webhooks libraries). `standard_webhooks` only. (Not always sent.)" } }, "required": [ "Content-Type", "X-Webhook-Event-Id", "X-Webhook-Event-Type", "X-Webhook-Timestamp", "X-Webhook-Signature" ], "additionalProperties": true }, "headers.open-platform": { "type": "object", "properties": { "Content-Type": { "type": "string", "description": "`application/json`." }, "X-Open-Event": { "type": "string", "description": "The event type." }, "X-Open-Delivery": { "type": "string", "description": "The delivery id (`delivery_id` in the body; a UUID for `endpoint.verify`)." }, "X-Open-Job": { "type": "string", "description": "The job id (`job_id` in the body). Only for a job whose callback asked for CloudEvents or Standard Webhooks; never on `endpoint.verify`. (Not always sent.)" }, "X-Open-Timestamp": { "type": "string", "description": "Unix seconds of this attempt." }, "X-Open-Signature": { "type": "string", "description": "`v1=` + hex HMAC-SHA256 of `\"{timestamp}.{raw body}\"`; sent only when the request gave a `callback.secret`. (Not always sent.)" }, "ce-specversion": { "type": "string", "description": "`1.0`. CloudEvents binary mode (`ce_binary`) only. (Not always sent.)" }, "ce-id": { "type": "string", "description": "The delivery id (X-Open-Delivery). `ce_binary` only. (Not always sent.)" }, "ce-source": { "type": "string", "description": "`{app url}/webhook-sources/{sender}/{business id}`, naming the business that sends the event. `ce_binary` only. (Not always sent.)" }, "ce-type": { "type": "string", "description": "`ca.superroute.` + the event type. `ce_binary` only. (Not always sent.)" }, "ce-subject": { "type": "string", "description": "`job/{job_id}`. `ce_binary` only. (Not always sent.)" }, "ce-time": { "type": "string", "description": "RFC 3339 time of the event. `ce_binary` only. (Not always sent.)" }, "ce-dataschema": { "type": "string", "description": "URL of this message's payload schema in this document. `ce_binary` only. (Not always sent.)" }, "ce-srbusiness": { "type": "string", "description": "Id of the sending business. `ce_binary` only. (Not always sent.)" }, "ce-srattempt": { "type": "string", "description": "Delivery attempt number, starting at 1. `ce_binary` only. (Not always sent.)" }, "webhook-id": { "type": "string", "description": "Standard Webhooks v1 id; same value as ce-id. `standard_webhooks` only. (Not always sent.)" }, "webhook-timestamp": { "type": "string", "description": "Same value as X-Open-Timestamp. `standard_webhooks` only. (Not always sent.)" }, "webhook-signature": { "type": "string", "description": "`v1,` + base64 HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with `callback.secret`, which is required for it (`whsec_` + base64 of it for Standard Webhooks libraries). `standard_webhooks` only. (Not always sent.)" } }, "required": [ "Content-Type", "X-Open-Event", "X-Open-Delivery", "X-Open-Timestamp" ], "additionalProperties": true }, "headers.ohp": { "type": "object", "properties": { "Content-Type": { "type": "string", "description": "`application/json`; `application/cloudevents+json` for a subscription set to `ce_structured`." }, "X-Ohp-Event": { "type": "string", "description": "The event type." }, "X-Ohp-Delivery": { "type": "string", "description": "The delivery id (`message_id` in the body); the same on every retry." }, "X-Ohp-Timestamp": { "type": "string", "description": "Unix seconds of this attempt." }, "X-Ohp-Signature": { "type": "string", "description": "`v1=` + hex HMAC-SHA256 of `\"{timestamp}.{raw body}\"` with the subscription's secret — the Open Platform callback recipe." }, "ce-specversion": { "type": "string", "description": "`1.0`. CloudEvents binary mode (`ce_binary`) only. (Not always sent.)" }, "ce-id": { "type": "string", "description": "The delivery id (X-Ohp-Delivery). `ce_binary` only. (Not always sent.)" }, "ce-source": { "type": "string", "description": "`{app url}/webhook-sources/{sender}/{business id}`, naming the business that sends the event. `ce_binary` only. (Not always sent.)" }, "ce-type": { "type": "string", "description": "`ca.superroute.` + the event type. `ce_binary` only. (Not always sent.)" }, "ce-subject": { "type": "string", "description": "`handoff/{handoff_ref}`. `ce_binary` only. (Not always sent.)" }, "ce-time": { "type": "string", "description": "RFC 3339 time of the event. `ce_binary` only. (Not always sent.)" }, "ce-dataschema": { "type": "string", "description": "URL of this message's payload schema in this document. `ce_binary` only. (Not always sent.)" }, "ce-srbusiness": { "type": "string", "description": "Id of the sending business. `ce_binary` only. (Not always sent.)" }, "ce-srattempt": { "type": "string", "description": "Delivery attempt number, starting at 1. `ce_binary` only. (Not always sent.)" }, "webhook-id": { "type": "string", "description": "Standard Webhooks v1 id; same value as ce-id. `standard_webhooks` only. (Not always sent.)" }, "webhook-timestamp": { "type": "string", "description": "Same value as X-Ohp-Timestamp. `standard_webhooks` only. (Not always sent.)" }, "webhook-signature": { "type": "string", "description": "`v1,` + base64 HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with the subscription's secret (`whsec_` + base64 of it for Standard Webhooks libraries). `standard_webhooks` only. (Not always sent.)" } }, "required": [ "Content-Type", "X-Ohp-Event", "X-Ohp-Delivery", "X-Ohp-Timestamp", "X-Ohp-Signature" ], "additionalProperties": true }, "headers.dataset": { "type": "object", "properties": { "Content-Type": { "type": "string", "description": "`application/json`." }, "X-Webhook-Event": { "type": "string", "description": "The event type." }, "X-Webhook-Timestamp": { "type": "string", "description": "Unix seconds of the send. Not covered by the signature." }, "X-Webhook-Signature": { "type": "string", "description": "Hex HMAC-SHA256 of the body JSON-encoded with default flags, no prefix; sent only when the webhook has a secret. (Not always sent.)" }, "ce-specversion": { "type": "string", "description": "`1.0`. CloudEvents binary mode (`ce_binary`) only. (Not always sent.)" }, "ce-id": { "type": "string", "description": "A UUID for the event, the same on every retry. `ce_binary` only. (Not always sent.)" }, "ce-source": { "type": "string", "description": "`{app url}/webhook-sources/{sender}/{business id}`, naming the business that sends the event. `ce_binary` only. (Not always sent.)" }, "ce-type": { "type": "string", "description": "`ca.superroute.` + the event type. `ce_binary` only. (Not always sent.)" }, "ce-subject": { "type": "string", "description": "`dataset/{dataset_id}`. `ce_binary` only. (Not always sent.)" }, "ce-time": { "type": "string", "description": "RFC 3339 time of the event. `ce_binary` only. (Not always sent.)" }, "ce-dataschema": { "type": "string", "description": "URL of this message's payload schema in this document. `ce_binary` only. (Not always sent.)" }, "ce-srbusiness": { "type": "string", "description": "Id of the sending business. `ce_binary` only. (Not always sent.)" }, "ce-srattempt": { "type": "string", "description": "Delivery attempt number, starting at 1. `ce_binary` only. (Not always sent.)" }, "webhook-id": { "type": "string", "description": "Standard Webhooks v1 id; same value as ce-id. `standard_webhooks` only. (Not always sent.)" }, "webhook-timestamp": { "type": "string", "description": "Same value as X-Webhook-Timestamp. `standard_webhooks` only. (Not always sent.)" }, "webhook-signature": { "type": "string", "description": "`v1,` + base64 HMAC-SHA256 of `\"{webhook-id}.{webhook-timestamp}.{raw body}\"` with the webhook's secret, which is required for it (`whsec_` + base64 of it for Standard Webhooks libraries). `standard_webhooks` only. (Not always sent.)" } }, "required": [ "Content-Type", "X-Webhook-Event", "X-Webhook-Timestamp" ], "additionalProperties": true }, "tenant.order.created": { "type": "object", "properties": { "result": { "type": "boolean", "description": "`true` for a created order." }, "id": { "type": "integer", "description": "Order id." }, "ref": { "type": [ "string", "null" ], "description": "Your order reference." }, "type": { "type": "string", "description": "Order type code (D delivery, P pickup, …)." }, "customer_id": { "type": [ "integer", "null" ] }, "tracking_number": { "type": "array", "description": "Tracking number of every package.", "items": { "type": "string" } }, "shipping_price": { "type": [ "string", "null" ], "description": "Two-decimal price; hidden when the recipient may not see prices." }, "price_details": { "type": [ "object", "null" ], "description": "Price breakdown.", "additionalProperties": true }, "currency": { "type": [ "string", "null" ] }, "rates": { "type": "array", "description": "Rate options, when the order was created with rating.", "items": { "type": "object", "additionalProperties": true } }, "best_rate": { "type": [ "object", "null" ], "additionalProperties": true }, "packages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "ref": { "type": [ "string", "null" ] }, "tracking_number": { "type": [ "string", "null" ] }, "external_tracking_number": { "type": [ "string", "null" ] } }, "required": [ "id" ], "additionalProperties": true } }, "warning": { "type": "string", "description": "Present only when the create produced a warning." } }, "required": [ "result", "id", "type", "tracking_number", "packages" ], "additionalProperties": true }, "tenant.order.status_change": { "type": "object", "properties": { "id": { "type": "integer", "description": "Operation event id." }, "action": { "type": "string", "enum": [ "created", "updated", "deleted" ] }, "user_id": { "type": [ "integer", "null" ] }, "business_id": { "type": [ "integer", "null" ] }, "location_id": { "type": [ "integer", "null" ] }, "location_information": { "type": "object", "description": "Name and address of `location_id`; present only when it is set.", "additionalProperties": true }, "grid_id": { "type": [ "integer", "null" ] }, "ip_address": { "type": [ "string", "null" ] }, "operation_category": { "type": [ "integer", "null" ] }, "operation_type": { "type": [ "integer", "null" ] }, "operation_category_text": { "type": [ "string", "null" ] }, "operation_type_text": { "type": [ "string", "null" ] }, "operation_description": { "type": [ "string", "null" ] }, "is_ascan": { "type": [ "integer", "boolean", "null" ] }, "route_id": { "type": [ "integer", "null" ] }, "order_id": { "type": [ "integer", "null" ] }, "before_status": { "type": [ "integer", "null" ] }, "after_status": { "type": [ "integer", "null" ] }, "tracking_event_id": { "type": [ "integer", "null" ] }, "gps_tracking_id": { "type": [ "integer", "null" ] }, "latitude": { "type": [ "number", "string", "null" ] }, "longitude": { "type": [ "number", "string", "null" ] }, "order_address_history_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "order_ref": { "type": [ "string", "null" ] }, "package_id": { "type": [ "integer", "null" ] }, "tracking_number": { "type": [ "string", "null" ] }, "external_tracking_number": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "return_reason": { "type": [ "string", "null" ] }, "shipping_to": { "type": [ "object", "array" ], "properties": { "name": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "telephone": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "address_1": { "type": [ "string", "null" ] }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "province": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] } }, "additionalProperties": true, "description": "An address object, or an empty array `[]` when there is none." }, "shipping_from": { "type": [ "object", "array" ], "properties": { "name": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "telephone": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "address_1": { "type": [ "string", "null" ] }, "address_2": { "type": [ "string", "null" ] }, "city": { "type": [ "string", "null" ] }, "province": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "code": { "type": [ "string", "null" ] }, "postcode": { "type": [ "string", "null" ] } }, "additionalProperties": true, "description": "An address object, or an empty array `[]` when there is none." }, "is_correction": { "type": "boolean", "description": "Present, `true`, only with the event envelope on, when the change corrects an earlier status." } }, "required": [ "id", "action" ], "additionalProperties": true }, "tenant.tracking.event": { "type": "object", "properties": { "id": { "type": "integer" }, "order_id": { "type": "integer" }, "order_ref": { "type": [ "string", "null" ] }, "location_id": { "type": [ "integer", "string", "null" ], "description": "Location id, or an empty string." }, "location_name": { "type": [ "string", "null" ] }, "tracking_event_type": { "type": [ "string", "null" ] }, "tracking_event_status_id": { "type": "integer" }, "tracking_event_key": { "type": [ "string", "null" ] }, "otep_status": { "type": [ "string", "null" ], "description": "OTEP status code." }, "description": { "type": "object", "description": "The event text keyed by language code.", "additionalProperties": true }, "proof_files": { "type": "array", "description": "Delivered and picked-up statuses only.", "items": { "type": "string" } }, "proof_files_detail": { "type": "array", "description": "Delivered and picked-up statuses only.", "items": { "type": "object", "properties": { "file_id": { "type": "integer" }, "type": { "type": "integer", "description": "1 signature, 2 photo, …" }, "note": { "type": [ "string", "null" ] }, "url": { "type": "string", "description": "Storage path." }, "full_url": { "type": "string" }, "signed_url": { "type": "string", "description": "Time-limited download URL; absent when the file was removed." }, "signed_url_expires_at": { "type": "integer", "description": "Unix seconds." }, "tracking_event_id": { "type": [ "integer", "null" ] }, "tracking_event_status_id": { "type": [ "integer", "null" ] }, "tracking_event_key": { "type": [ "string", "null" ] }, "service_type": { "type": [ "integer", "null" ] }, "service_status": { "type": [ "integer", "null" ] } }, "required": [ "file_id", "type", "url" ], "additionalProperties": true } }, "reason_id": { "type": [ "integer", "null" ] }, "reason": { "type": [ "string", "null" ] }, "visible_to_public": { "type": [ "boolean", "integer", "null" ] }, "tracking_number": { "type": "array", "items": { "type": "string" } }, "external_tracking_number": { "type": "array", "items": { "type": "string" } }, "occurred_at": { "type": "string", "description": "With the event envelope on only." }, "occurred_timestamp": { "type": "integer", "description": "With the event envelope on only." } }, "required": [ "id", "order_id", "tracking_event_status_id" ], "additionalProperties": true }, "tenant.order.create_async": { "type": [ "array", "object" ], "description": "Normally a JSON array with one row per submitted order. If the whole batch fails, a single object `{result: false, message}`.", "items": { "type": "object", "properties": { "result": { "type": "boolean", "description": "`false` for a row that was not created." }, "message": { "type": "string", "description": "Why the row was not created." }, "ref": { "type": [ "string", "null" ] }, "skipped_ref": { "type": [ "string", "null" ] }, "error_key": { "type": [ "string", "null" ] } }, "required": [ "result" ], "additionalProperties": true, "description": "A created order (same shape as `order.created`) or a failed row." }, "properties": { "result": { "type": "boolean" }, "message": { "type": "string" } } }, "tenant.pod.files_updated": { "type": "object", "properties": { "action": { "type": "string", "description": "`added`, `removed`, …" }, "order_id": { "type": "integer" }, "order_ref": { "type": [ "string", "null" ] }, "tracking_number": { "type": "array", "items": { "type": "string" } }, "external_tracking_number": { "type": "array", "items": { "type": "string" } }, "file": { "type": "object", "properties": { "file_id": { "type": "integer" }, "type": { "type": "integer", "description": "1 signature, 2 photo, …" }, "note": { "type": [ "string", "null" ] }, "url": { "type": "string", "description": "Storage path." }, "full_url": { "type": "string" }, "signed_url": { "type": "string", "description": "Time-limited download URL; absent when the file was removed." }, "signed_url_expires_at": { "type": "integer", "description": "Unix seconds." }, "tracking_event_id": { "type": [ "integer", "null" ] }, "tracking_event_status_id": { "type": [ "integer", "null" ] }, "tracking_event_key": { "type": [ "string", "null" ] }, "service_type": { "type": [ "integer", "null" ] }, "service_status": { "type": [ "integer", "null" ] } }, "required": [ "file_id", "type", "url" ], "additionalProperties": true }, "event_id": { "type": "string", "description": "Identity of this event; kept on retries and on manual redelivery." }, "event_time": { "type": "string", "description": "ISO 8601 time of the event." }, "event_timestamp": { "type": "integer", "description": "Unix seconds of the event." } }, "required": [ "action", "order_id", "file", "event_id", "event_time", "event_timestamp" ], "additionalProperties": true }, "tenant.order.deleted": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "deleted" ] }, "order_id": { "type": "integer" }, "order_ref": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "orders_status_id": { "type": [ "integer", "null" ] }, "tracking_number": { "type": "array", "items": { "type": "string" } }, "external_tracking_number": { "type": "array", "items": { "type": "string" } }, "event_id": { "type": "string", "description": "Identity of this event; kept on retries and on manual redelivery." }, "event_time": { "type": "string", "description": "ISO 8601 time of the event." }, "event_timestamp": { "type": "integer", "description": "Unix seconds of the event." } }, "required": [ "action", "order_id", "event_id", "event_time", "event_timestamp" ], "additionalProperties": true }, "tenant.order.cancel_failed": { "type": "object", "properties": { "result": { "type": "boolean", "description": "Always `false`." }, "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "http_status": { "type": "integer" }, "submitted": { "type": "object", "description": "What the cancel request named.", "properties": { "order_id": { "type": [ "integer", "string", "null" ] }, "tracking_number": { "type": [ "string", "null" ] }, "external_tracking_number": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "matched_order_ids": { "type": "array", "description": "Present only when the request matched several orders.", "items": { "type": "integer" } } }, "required": [ "result", "http_status", "submitted" ], "additionalProperties": true }, "tenant.route_board.seat_changed": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "route_board.seat_changed" ] }, "action": { "type": "string", "enum": [ "claimed", "standby", "pooled", "promoted", "withdrawn", "vetoed", "replaced", "assigned", "awarded", "lost", "displaced", "settled", "board_opened", "board_closed", "board_cancelled" ] }, "board": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "date": { "type": [ "string", "null" ] }, "mode": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "business_id": { "type": "integer" }, "broker_id": { "type": [ "integer", "null" ] } }, "required": [ "id" ], "additionalProperties": true }, "seat": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "route_id": { "type": [ "integer", "null" ] }, "slot_id": { "type": [ "integer", "null" ] }, "route_name": { "type": [ "string", "null" ] }, "work_from": { "type": [ "string", "null" ] }, "work_end": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "claim": { "type": [ "object", "null" ], "properties": { "id": { "type": "integer" }, "driver_id": { "type": [ "integer", "null" ] }, "driver_name": { "type": [ "string", "null" ] }, "driver_alias": { "type": [ "string", "null" ] }, "rank": { "type": [ "integer", "null" ] }, "status": { "type": [ "string", "null" ] }, "bid_price": { "type": [ "number", "null" ] }, "awarded_price": { "type": [ "number", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "additionalProperties": true }, "occurred_at": { "type": "string" }, "extra": { "type": "object", "description": "Action-specific details.", "additionalProperties": true } }, "required": [ "event", "action", "board", "seat", "claim", "occurred_at", "extra" ], "additionalProperties": true }, "tenant.order_lifecycle_event": { "type": "object", "description": "Order lifecycle event.", "properties": { "event_id": { "type": "string", "description": "`OLE-` + ULID; the identity of this event." }, "event_type": { "type": "string" }, "livemode": { "type": "boolean" }, "occurred_at": { "type": "string", "description": "ISO 8601." }, "data": { "type": "object", "properties": { "order_id": { "type": "integer" }, "order_ref": { "type": [ "string", "null" ] }, "tracking_number": { "type": [ "string", "null" ] }, "type": { "type": [ "string", "null" ] }, "status_id": { "type": [ "integer", "null" ] }, "previous_status_id": { "type": [ "integer", "null" ] }, "route_id": { "type": [ "integer", "null" ] }, "driver_id": { "type": [ "integer", "null" ] }, "driver_name": { "type": [ "string", "null" ] }, "previous_driver_id": { "type": [ "integer", "null" ] }, "customer_id": { "type": [ "integer", "null" ] }, "source": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "ready_by_user_id": { "type": [ "integer", "null" ] } }, "required": [ "order_id" ], "additionalProperties": true } }, "required": [ "event_id", "event_type", "livemode", "occurred_at", "data" ], "additionalProperties": true }, "tenant.driver.on_duty_changed": { "type": "object", "description": "Driver duty event.", "properties": { "event_id": { "type": "string", "description": "`OLE-` + ULID; the identity of this event." }, "event_type": { "type": "string" }, "livemode": { "type": "boolean" }, "occurred_at": { "type": "string", "description": "ISO 8601." }, "data": { "type": "object", "properties": { "driver_id": { "type": "integer" }, "driver_name": { "type": [ "string", "null" ] }, "on_duty": { "type": "boolean" }, "changed_at": { "type": "string" } }, "required": [ "driver_id", "on_duty" ], "additionalProperties": true } }, "required": [ "event_id", "event_type", "livemode", "occurred_at", "data" ], "additionalProperties": true }, "tenant.driver.location_update": { "type": "object", "description": "Driver position event.", "properties": { "event_id": { "type": "string", "description": "`OLE-` + ULID; the identity of this event." }, "event_type": { "type": "string" }, "livemode": { "type": "boolean" }, "occurred_at": { "type": "string", "description": "ISO 8601." }, "data": { "type": "object", "properties": { "driver_id": { "type": "integer" }, "driver_name": { "type": [ "string", "null" ] }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "recorded_at": { "type": "string" }, "route_id": { "type": "integer" }, "order_id": { "type": "integer" }, "heading": { "type": "number" }, "speed": { "type": "number" }, "accuracy": { "type": "number" } }, "required": [ "driver_id", "latitude", "longitude", "recorded_at" ], "additionalProperties": true } }, "required": [ "event_id", "event_type", "livemode", "occurred_at", "data" ], "additionalProperties": true }, "tenant.device_order_event": { "type": "object", "properties": { "event_id": { "type": "string", "description": "`DOE-` + ledger id; the same for the same event every time it is sent." }, "event_type": { "type": "string" }, "livemode": { "type": "boolean" }, "occurred_at": { "type": [ "string", "null" ] }, "data": { "type": "object", "properties": { "device_order": { "type": "object", "properties": { "id": { "type": "integer" }, "kind": { "type": "string" }, "status": { "type": "string" }, "next_actor": { "type": [ "string", "null" ] }, "device_type": { "type": [ "string", "null" ] }, "device_id": { "type": [ "integer", "null" ] }, "device_name": { "type": [ "string", "null" ] }, "grid_code": { "type": [ "string", "null" ] }, "reference_number": { "type": [ "string", "null" ] }, "order_id": { "type": [ "integer", "null" ] }, "external_order_id": { "type": [ "string", "null" ] }, "due_at": { "type": [ "string", "null" ] }, "overdue_at": { "type": [ "string", "null" ] }, "stored_at": { "type": [ "string", "null" ] }, "ended_at": { "type": [ "string", "null" ] }, "removal_reason": { "type": [ "string", "null" ] } }, "required": [ "id", "kind", "status" ], "additionalProperties": true }, "exception": { "type": "object", "description": "Exception events only.", "properties": { "id": { "type": [ "integer", "null" ] }, "type": { "type": [ "string", "null" ] }, "severity": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "resolution_action": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "required": [ "device_order" ], "additionalProperties": true } }, "required": [ "event_id", "event_type", "livemode", "data" ], "additionalProperties": true }, "partner-locker.event": { "type": "object", "properties": { "event_id": { "type": "string", "description": "`PLE-` + ULID (`PLE-MOCK-` on sandbox events)." }, "event_type": { "type": "string" }, "livemode": { "type": "boolean", "description": "`false` on sandbox events." }, "occurred_at": { "type": [ "string", "null" ] }, "data": { "type": "object", "description": "Delivery or carrier-package details. Keys whose value is null are left out.", "additionalProperties": true } }, "required": [ "event_id", "event_type", "livemode", "data" ], "additionalProperties": true }, "tpd.assignment_event": { "type": "object", "properties": { "event_id": { "type": "string", "description": "`TPDE-` + ULID." }, "event_type": { "type": "string" }, "occurred_at": { "type": [ "string", "null" ] }, "data": { "type": "object", "description": "Keys whose value is null are left out.", "properties": { "assignment_no": { "type": "string" }, "assignment_status": { "type": [ "string", "null" ] }, "order_id": { "type": [ "integer", "null" ] }, "external_order_number": { "type": [ "string", "null" ] }, "order_ref": { "type": [ "string", "null" ] }, "packages": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "legs": { "type": "array", "description": "Present only when the assignment has legs.", "items": { "type": "object", "additionalProperties": true } }, "reason": { "type": [ "string", "null" ] } }, "required": [ "assignment_no" ], "additionalProperties": true } }, "required": [ "event_id", "event_type", "data" ], "additionalProperties": true }, "loading-plan.event": { "type": "object", "properties": { "event_id": { "type": "string", "description": "UUID." }, "event_type": { "type": "string" }, "occurred_at": { "type": "string", "description": "ISO 8601; fixed when the event is queued." }, "data": { "type": "object", "description": "Keys whose value is null are left out.", "properties": { "request_id": { "type": [ "string", "null" ] }, "loading_plan_id": { "type": "integer" }, "solve_run_id": { "type": "integer" }, "status": { "type": "string" }, "error_code": { "type": [ "string", "null" ] }, "candidate_id": { "type": "integer", "description": "`loading_plan.finalized` only." }, "status_path": { "type": "string", "description": "API path to read the run." } }, "required": [ "loading_plan_id", "solve_run_id", "status", "status_path" ], "additionalProperties": true } }, "required": [ "event_id", "event_type", "occurred_at", "data" ], "additionalProperties": true }, "open-platform.endpoint.verify": { "type": "object", "properties": { "event": { "type": "string", "enum": [ "endpoint.verify" ] }, "challenge": { "type": "string", "description": "Echo this value back in the response body." }, "occurred_at": { "type": "string" } }, "required": [ "event", "challenge", "occurred_at" ], "additionalProperties": true }, "open-platform.job_event": { "type": "object", "properties": { "event": { "type": "string" }, "delivery_id": { "type": "string", "description": "`dlv_` + ULID." }, "job_id": { "type": "string", "description": "`job_` + ULID." }, "request_id": { "type": [ "string", "null" ] }, "capability": { "type": "string" }, "occurred_at": { "type": "string", "description": "Time of this attempt." }, "attempt": { "type": "integer" }, "status": { "type": [ "string", "null" ] } }, "required": [ "event", "delivery_id", "job_id", "capability", "occurred_at", "attempt" ], "additionalProperties": true }, "open-platform.job.succeeded": { "type": "object", "properties": { "event": { "type": "string" }, "delivery_id": { "type": "string", "description": "`dlv_` + ULID." }, "job_id": { "type": "string", "description": "`job_` + ULID." }, "request_id": { "type": [ "string", "null" ] }, "capability": { "type": "string" }, "occurred_at": { "type": "string", "description": "Time of this attempt." }, "attempt": { "type": "integer" }, "status": { "type": [ "string", "null" ] }, "result_url": { "type": "string" }, "result_expires_at": { "type": [ "string", "null" ] }, "data": { "description": "The result, inline only when it is small enough; otherwise fetch `result_url`." } }, "required": [ "event", "delivery_id", "job_id", "capability", "occurred_at", "attempt", "result_url" ], "additionalProperties": true }, "open-platform.job.failed": { "type": "object", "properties": { "event": { "type": "string" }, "delivery_id": { "type": "string", "description": "`dlv_` + ULID." }, "job_id": { "type": "string", "description": "`job_` + ULID." }, "request_id": { "type": [ "string", "null" ] }, "capability": { "type": "string" }, "occurred_at": { "type": "string", "description": "Time of this attempt." }, "attempt": { "type": "integer" }, "status": { "type": [ "string", "null" ] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": true } }, "required": [ "event", "delivery_id", "job_id", "capability", "occurred_at", "attempt", "error" ], "additionalProperties": true }, "ohp.subscription.verify": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "challenge": { "type": "string", "description": "Echo this value back, bare or as `{\"challenge\": …}`." } }, "required": [ "challenge" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "ohp.handoff.accepted": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "handoff_ref": { "type": "string", "description": "The handoff's reference." }, "status": { "type": "string", "description": "The commercial state (docs/standards/ohp.md §4)." }, "tracking_numbers": { "type": "array", "items": { "type": "string" } } }, "required": [ "handoff_ref", "status" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "ohp.handoff.rejected": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "handoff_ref": { "type": "string", "description": "The handoff's reference." }, "status": { "type": "string", "description": "The commercial state (docs/standards/ohp.md §4)." }, "reason": { "type": [ "string", "null" ], "description": "The grantor's reason." } }, "required": [ "handoff_ref", "status" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "ohp.handoff.expired": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "handoff_ref": { "type": "string", "description": "The handoff's reference." }, "status": { "type": "string", "description": "The commercial state (docs/standards/ohp.md §4)." } }, "required": [ "handoff_ref", "status" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "ohp.amendment.accepted": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "handoff_ref": { "type": "string", "description": "The handoff's reference." }, "status": { "type": "string", "description": "The commercial state (docs/standards/ohp.md §4)." }, "amendment_id": { "type": "integer" }, "price_delta": { "type": [ "number", "null" ], "description": "Signed price change, when one was charged." }, "currency": { "type": [ "string", "null" ] }, "answer_note": { "type": [ "string", "null" ] } }, "required": [ "handoff_ref", "amendment_id", "status" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "ohp.amendment.rejected": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "handoff_ref": { "type": "string", "description": "The handoff's reference." }, "status": { "type": "string", "description": "The commercial state (docs/standards/ohp.md §4)." }, "amendment_id": { "type": "integer" }, "answer_note": { "type": [ "string", "null" ] } }, "required": [ "handoff_ref", "amendment_id", "status" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "ohp.handoff.tracking": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "handoff_ref": { "type": "string" }, "event": { "type": "object", "properties": { "status_code": { "type": "string", "description": "An OTEP status code (docs/standards/otep.md)." }, "occurred_at": { "type": [ "string", "null" ] } }, "required": [ "status_code" ], "additionalProperties": true } }, "required": [ "handoff_ref", "event" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "ohp.settlement_line.created": { "type": "object", "properties": { "ohp_version": { "type": "string", "description": "`0.1`." }, "profile": { "type": "string", "description": "`parcel`." }, "message_id": { "type": "string", "description": "The delivery id; the same on every retry — dedupe on it." }, "sent_at": { "type": "string", "description": "ISO 8601 time of this attempt." }, "body": { "type": "object", "properties": { "event": { "type": "string", "description": "The event type." }, "data": { "type": "object", "description": "", "properties": { "line_id": { "type": "string" }, "handoff_ref": { "type": "string" }, "kind": { "type": "string", "enum": [ "adjustment", "cancellation_fee", "credit" ] }, "amount": { "type": "number", "description": "Signed: positive = the sender owes more, negative = a credit." }, "currency": { "type": "string" }, "reason": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] } }, "required": [ "line_id", "handoff_ref", "kind", "amount", "currency" ], "additionalProperties": true } }, "required": [ "event", "data" ], "additionalProperties": true } }, "required": [ "ohp_version", "message_id", "body" ], "additionalProperties": true }, "dataset.test": { "type": "object", "properties": { "event": { "type": "string" }, "timestamp": { "type": "string" }, "dataset_id": { "type": [ "integer", "null" ] }, "data": { "type": "object", "properties": { "test": { "type": "boolean" }, "message": { "type": "string" }, "webhook_id": { "type": "integer" }, "webhook_name": { "type": [ "string", "null" ] } }, "additionalProperties": true } }, "required": [ "event", "timestamp", "data" ], "additionalProperties": true }, "dataset.record_created": { "type": "object", "properties": { "event": { "type": "string" }, "timestamp": { "type": "string", "description": "When this attempt was sent." }, "dataset_id": { "type": [ "integer", "null" ] }, "data": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "integer" }, "group_id": { "type": "integer" }, "dataset_id": { "type": [ "integer", "null" ] }, "row_number": { "type": [ "integer", "null" ] }, "data": { "type": "object", "description": "The record's values keyed by column code; may hold personal data.", "additionalProperties": true }, "address_combined": { "type": [ "string", "null" ] }, "latitude": { "type": [ "number", "null" ] }, "longitude": { "type": [ "number", "null" ] }, "geocode_status": { "type": [ "string", "null" ] }, "validation_status": { "type": [ "string", "null" ] }, "validation_errors": { "description": "Validation errors by column, or null." }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "group_id", "data" ], "additionalProperties": true }, "occurred_at": { "type": "string", "description": "When the event happened." } }, "required": [ "record", "occurred_at" ], "additionalProperties": true } }, "required": [ "event", "timestamp", "data" ], "additionalProperties": true }, "dataset.record_updated": { "type": "object", "properties": { "event": { "type": "string" }, "timestamp": { "type": "string", "description": "When this attempt was sent." }, "dataset_id": { "type": [ "integer", "null" ] }, "data": { "type": "object", "properties": { "record": { "type": "object", "properties": { "id": { "type": "integer" }, "group_id": { "type": "integer" }, "dataset_id": { "type": [ "integer", "null" ] }, "row_number": { "type": [ "integer", "null" ] }, "data": { "type": "object", "description": "The record's values keyed by column code; may hold personal data.", "additionalProperties": true }, "address_combined": { "type": [ "string", "null" ] }, "latitude": { "type": [ "number", "null" ] }, "longitude": { "type": [ "number", "null" ] }, "geocode_status": { "type": [ "string", "null" ] }, "validation_status": { "type": [ "string", "null" ] }, "validation_errors": { "description": "Validation errors by column, or null." }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] } }, "required": [ "id", "group_id", "data" ], "additionalProperties": true }, "changed": { "type": "array", "description": "Codes of the columns whose value changed.", "items": { "type": "string" } }, "previous": { "type": "object", "description": "The changed columns' values before the edit.", "additionalProperties": true }, "occurred_at": { "type": "string", "description": "When the event happened." } }, "required": [ "record", "changed", "previous", "occurred_at" ], "additionalProperties": true } }, "required": [ "event", "timestamp", "data" ], "additionalProperties": true }, "dataset.import_completed": { "type": "object", "properties": { "event": { "type": "string" }, "timestamp": { "type": "string", "description": "When this attempt was sent." }, "dataset_id": { "type": [ "integer", "null" ] }, "data": { "type": "object", "properties": { "group_id": { "type": "integer" }, "dataset_id": { "type": "integer" }, "source": { "type": "string", "enum": [ "file", "scheduled", "copy", "merge" ] }, "status": { "type": "string", "description": "`geocoding`: imported, geocoding started; geocode_completed follows.", "enum": [ "completed", "failed", "geocoding" ] }, "created": { "type": "integer" }, "updated": { "type": "integer" }, "skipped": { "type": "integer" }, "errors": { "type": "integer" }, "invalid": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "scheduled_import_id": { "type": "integer", "description": "Scheduled imports only." }, "source_group_ids": { "type": "array", "description": "Copies and merges only.", "items": { "type": "integer" } }, "source_groups_deleted": { "type": "boolean", "description": "Merges only." }, "occurred_at": { "type": "string", "description": "When the event happened." } }, "required": [ "group_id", "dataset_id", "source", "status", "created", "updated", "skipped", "errors", "invalid", "error", "occurred_at" ], "additionalProperties": true } }, "required": [ "event", "timestamp", "data" ], "additionalProperties": true }, "dataset.geocode_completed": { "type": "object", "properties": { "event": { "type": "string" }, "timestamp": { "type": "string", "description": "When this attempt was sent." }, "dataset_id": { "type": [ "integer", "null" ] }, "data": { "type": "object", "properties": { "group_id": { "type": "integer" }, "dataset_id": { "type": "integer" }, "success": { "type": "integer" }, "failed": { "type": "integer" }, "skipped": { "type": "integer" }, "pending": { "type": "integer" }, "occurred_at": { "type": "string", "description": "When the event happened." } }, "required": [ "group_id", "dataset_id", "success", "failed", "skipped", "pending", "occurred_at" ], "additionalProperties": true } }, "required": [ "event", "timestamp", "data" ], "additionalProperties": true }, "dataset.validation_failed": { "type": "object", "properties": { "event": { "type": "string" }, "timestamp": { "type": "string", "description": "When this attempt was sent." }, "dataset_id": { "type": [ "integer", "null" ] }, "data": { "type": "object", "properties": { "group_id": { "type": "integer" }, "dataset_id": { "type": "integer" }, "valid": { "type": "integer" }, "invalid": { "type": "integer" }, "skipped": { "type": "integer" }, "failures": { "type": "array", "description": "At most 100.", "items": { "type": "object", "properties": { "record_id": { "type": "integer" }, "errors": { "description": "Errors by column." } }, "required": [ "record_id", "errors" ], "additionalProperties": true } }, "truncated": { "type": "boolean", "description": "More failures than listed." }, "occurred_at": { "type": "string", "description": "When the event happened." } }, "required": [ "group_id", "dataset_id", "valid", "invalid", "skipped", "failures", "truncated", "occurred_at" ], "additionalProperties": true } }, "required": [ "event", "timestamp", "data" ], "additionalProperties": true }, "dataset.duplicate_found": { "type": "object", "properties": { "event": { "type": "string" }, "timestamp": { "type": "string", "description": "When this attempt was sent." }, "dataset_id": { "type": [ "integer", "null" ] }, "data": { "type": "object", "properties": { "group_id": { "type": "integer" }, "dataset_id": { "type": "integer" }, "source": { "type": "string", "enum": [ "detect", "merge" ] }, "count": { "type": "integer" }, "pairs": { "type": "array", "description": "At most 100.", "items": { "type": "object", "properties": { "original_id": { "type": "integer" }, "duplicate_id": { "type": "integer" } }, "required": [ "original_id", "duplicate_id" ], "additionalProperties": true } }, "truncated": { "type": "boolean", "description": "More duplicates than listed." }, "occurred_at": { "type": "string", "description": "When the event happened." } }, "required": [ "group_id", "dataset_id", "source", "count", "pairs", "truncated", "occurred_at" ], "additionalProperties": true } }, "required": [ "event", "timestamp", "data" ], "additionalProperties": true } }, "messages": { "tenant.order.created": { "name": "order.created", "title": "order.created", "summary": "An order was created.", "description": "Sent once per created order. Orders of types other than local delivery are sent only when `order_created_webhook_all_types` is 1. Orders from a batch are not sent here when `order_create_async_postback_url` is set; the batch result goes there instead.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order.created" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "result": true, "id": 1001, "ref": "REF-001", "type": "D", "customer_id": 42, "tracking_number": [ "SR000000001" ], "shipping_price": "13.30", "price_details": { "shipping_fee": "10.00", "signature_fee": "1.50", "sub_total": "11.50", "tax_details": [ { "tax_number_id": 3, "tax_name": "HST", "tax_rate": 13, "tax": "1.50" } ], "tax_zone_id": 7 }, "currency": "CAD", "packages": [ { "id": 2001, "ref": "PKG-001", "tracking_number": "SR000000001", "external_tracking_number": "1Z999AA10123456784" } ] } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_create_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.status_change": { "name": "order.status_change", "title": "order.status_change", "summary": "An operation changed an order's status.", "description": "Sent once per package of the order.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order.status_change" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "id": 50001, "user_id": 3011, "business_id": 42, "location_id": 12, "location_information": { "name": "Toronto Depot", "address_1": "10 King St", "address_2": "", "city": "Toronto", "province": "ON", "country": "Canada", "postcode": "M5V1A1", "territory_id": 7, "territory_name": "Downtown" }, "grid_id": null, "ip_address": "203.0.113.24", "operation_category": 1, "operation_type": 1001, "is_ascan": 0, "operation_description": null, "route_id": 8801, "order_id": 1001, "before_status": 20, "after_status": 8, "tracking_event_id": 90001, "gps_tracking_id": 77012, "latitude": "43.6532", "longitude": "-79.3832", "order_address_history_id": null, "created_at": "2026-01-15 10:00:00", "updated_at": "2026-01-15 10:00:00", "action": "created", "operation_type_text": "driver change status", "operation_category_text": "driver", "order_ref": "REF-001", "package_id": 2001, "tracking_number": "SR000000001", "external_tracking_number": "1Z999AA10123456784", "type": "D", "return_reason": "", "shipping_to": { "name": "Jane Doe", "company_name": "", "telephone": "+14165550123", "email": "jane@example.com", "address_1": "55 Queen St W", "address_2": "Unit 8", "city": "Toronto", "province": "ON", "country": "Canada", "code": "", "postcode": "M5H2M9" }, "shipping_from": { "name": "Toronto Depot", "company_name": "Acme Logistics", "telephone": "+14165550100", "address_1": "10 King St", "address_2": "", "city": "Toronto", "province": "ON", "country": "Canada", "code": "", "postcode": "M5V1A1" } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_status_change_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.tracking.event": { "name": "tracking.event", "title": "tracking.event", "summary": "A tracking event was recorded.", "description": "Proof files, failure reasons and tracking numbers are present only when they apply.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.tracking.event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "id": 90001, "order_id": 1001, "order_ref": "REF-001", "location_id": 12, "location_name": "Toronto Depot", "tracking_event_type": "D", "tracking_event_status_id": 500, "tracking_event_key": "deliver_success", "otep_status": "delivered", "proof_files": [ "storage/2026-07-20/1001_S_Ab3kQ9xYzLm4Np.jpeg", "storage/2026-07-20/1001_P_Cd7rT2wVuKe8Hs.jpeg" ], "proof_files_detail": [ { "file_id": 234567, "type": 1, "url": "storage/2026-07-20/1001_S_Ab3kQ9xYzLm4Np.jpeg", "full_url": "https://api.superroute.ca/storage/2026-07-20/1001_S_Ab3kQ9xYzLm4Np.jpeg", "signed_url": "https://api.superroute.ca/files/pod/234567?expires=1784748600&signature=8f2c1d...", "signed_url_expires_at": 1784748600, "tracking_event_id": 90001, "tracking_event_status_id": 500, "tracking_event_key": "deliver_success", "service_type": 1, "service_status": 1 }, { "file_id": 234568, "type": 2, "url": "storage/2026-07-20/1001_P_Cd7rT2wVuKe8Hs.jpeg", "full_url": "https://api.superroute.ca/storage/2026-07-20/1001_P_Cd7rT2wVuKe8Hs.jpeg", "signed_url": "https://api.superroute.ca/files/pod/234568?expires=1784748600&signature=41ba90...", "signed_url_expires_at": 1784748600, "tracking_event_id": 90001, "tracking_event_status_id": 500, "tracking_event_key": "deliver_success", "service_type": 1, "service_status": 1 } ], "description": { "en": "Your parcel has been delivered successfully. Thank you!", "fr": "Votre colis a été livré avec succès. Merci !", "chs": "您的包裹已成功送达，感谢您的使用！", "cht": "您的包裹已成功送達，感謝您的使用！", "es": "Tu paquete ha sido entregado con éxito. ¡Gracias!", "de": "Ihr Paket wurde erfolgreich zugestellt. Vielen Dank!", "nl": "Uw pakket is succesvol afgeleverd, bedankt voor uw gebruik!", "pt": "Seu pacote foi entregue com sucesso. Obrigado!", "it": "Il tuo pacco è stato consegnato con successo. Grazie!", "sr": "Vaš paket je uspešno dostavljen, hvala vam što koristite naše usluge!", "hu": "Csomagja sikeresen kiszállításra került, köszönjük hogy használta szolgáltatásunkat!", "pl": "Twoja paczka została dostarczona pomyślnie. Dziękujemy!", "sk": "Váš balík bol úspešne doručený. Ďakujeme!", "cs": "Váš balík byl úspěšně doručen. Děkujeme!" }, "tracking_number": [ "SR000000001" ], "external_tracking_number": [ "1Z999AA10123456784" ] } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "tracking_event_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.create_async": { "name": "order.create_async", "title": "order.create_async", "summary": "Result of an asynchronous batch create.", "description": "The body is a JSON array, never enveloped. Operations may resend a batch result manually; the resend carries the same body.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order.create_async" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": [ { "result": true, "id": 1001, "ref": "REF-001", "type": "D", "customer_id": 42, "tracking_number": [ "SR000000001" ], "shipping_price": "13.30", "currency": "CAD", "packages": [ { "id": 2001, "ref": "PKG-001", "tracking_number": "SR000000001", "external_tracking_number": "1Z999AA10123456784" } ] }, { "result": false, "message": "Please provider a valid postcode", "ref": "REF-002" } ] } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_create_async_postback_url", "x-superroute-body": "list", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.pod.files_updated": { "name": "pod.files_updated", "title": "pod.files_updated", "summary": "A proof-of-delivery file was added or removed.", "description": "Always carries `event_id`, `event_time` and `event_timestamp`, whatever the envelope setting.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.pod.files_updated" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "action": "added", "order_id": 1001, "order_ref": "REF-001", "tracking_number": [ "SR000000001" ], "external_tracking_number": [ "1Z999AA10123456784" ], "file": { "file_id": 234567, "type": 1, "note": null, "url": "storage/2026-07-20/1001_S_Ab3kQ9xYzLm4Np.jpeg", "full_url": "https://api.superroute.ca/storage/2026-07-20/1001_S_Ab3kQ9xYzLm4Np.jpeg", "signed_url": "https://api.superroute.ca/files/pod/234567?expires=1784748600&signature=8f2c1d...", "signed_url_expires_at": 1784748600, "tracking_event_id": 90001, "tracking_event_status_id": 500, "tracking_event_key": "deliver_success", "service_type": 1, "service_status": 1 }, "event_id": "9b2e4c7a-1f30-4d8e-8a55-6c0f1e2d3a4b", "event_time": "2026-01-15T10:00:00-05:00", "event_timestamp": 1768489200 } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "pod_files_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.deleted": { "name": "order.deleted", "title": "order.deleted", "summary": "An order was deleted.", "description": "Always carries `event_id`, `event_time` and `event_timestamp`, whatever the envelope setting.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order.deleted" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "action": "deleted", "order_id": 1001, "order_ref": "REF-001", "type": "D", "orders_status_id": 2, "tracking_number": [ "SR000000001" ], "external_tracking_number": [ "1Z999AA10123456784" ], "event_id": "4c1a7f92-0b6d-4e11-9c3a-2f7b5d8e6a10", "event_time": "2026-01-15T10:00:00-05:00", "event_timestamp": 1768489200 } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_deleted_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.cancel_failed": { "name": "order.cancel_failed", "title": "order.cancel_failed", "summary": "A cancel request through the API could not be carried out.", "description": "Sent to the caller of the cancel request.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order.cancel_failed" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "result": false, "code": "ORDER_ALREADY_IN_DELIVERY", "message": "Order can no longer be cancelled at its current status", "http_status": 409, "submitted": { "order_id": 1001, "tracking_number": "SR000000001", "external_tracking_number": null } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_cancel_failed_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.route_board.seat_changed": { "name": "route_board.seat_changed", "title": "route_board.seat_changed", "summary": "A seat on a route board changed.", "description": "Business recipients only.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.route_board.seat_changed" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event": "route_board.seat_changed", "action": "claimed", "board": { "id": 12, "title": "Thursday AM routes", "date": "2026-09-10", "mode": "route", "status": "open", "business_id": 7, "broker_id": null }, "seat": { "id": 301, "route_id": 940, "slot_id": 950, "route_name": "North Loop", "work_from": "08:00", "work_end": "12:00", "status": "filled" }, "claim": { "id": 5001, "driver_id": 920, "driver_name": "Alex Driver", "driver_alias": "AD", "rank": 1, "status": "primary", "bid_price": null, "awarded_price": null, "reason": null }, "occurred_at": "2026-01-15T10:00:00-05:00", "extra": {} } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "route_board_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.assigned": { "name": "order.assigned", "title": "order.assigned", "summary": "The order was assigned to a driver.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.assigned", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 16, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "source": "auto_assign", "previous_driver_id": null } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.unassigned": { "name": "order.unassigned", "title": "order.unassigned", "summary": "The order lost its driver.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.unassigned", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 16, "route_id": 5120, "driver_id": null, "driver_name": "Alex", "customer_id": 77, "previous_driver_id": 42, "source": "driver_duty_release" } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.accepted": { "name": "order.accepted", "title": "order.accepted", "summary": "The driver accepted the order.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.accepted", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 16, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "reason": null } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.rejected": { "name": "order.rejected", "title": "order.rejected", "summary": "The driver rejected the order.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.rejected", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 16, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "reason": "Too far away" } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.pickup_started": { "name": "order.pickup_started", "title": "order.pickup_started", "summary": "The driver started the pickup.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.pickup_started", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 45, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "previous_status_id": 16 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.picked_up": { "name": "order.picked_up", "title": "order.picked_up", "summary": "The order was picked up.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.picked_up", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 7, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "previous_status_id": 45 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.on_the_way": { "name": "order.on_the_way", "title": "order.on_the_way", "summary": "The driver is on the way to the recipient.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.on_the_way", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 46, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "previous_status_id": 7 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.completed": { "name": "order.completed", "title": "order.completed", "summary": "The order was completed.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.completed", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 8, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "previous_status_id": 46 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.failed": { "name": "order.failed", "title": "order.failed", "summary": "The delivery failed.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.failed", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 9, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "previous_status_id": 46 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.cancelled": { "name": "order.cancelled", "title": "order.cancelled", "summary": "The order was cancelled.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.cancelled", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 12, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "previous_status_id": 16 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.order.ready": { "name": "order.ready", "title": "order.ready", "summary": "The order was marked ready for pickup.", "description": "Narrowed by `order_lifecycle_events` (empty: all). The same event for the same order and driver is sent at most once per minute.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.order_lifecycle_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDE", "event_type": "order.ready", "livemode": true, "occurred_at": "2026-08-17T10:00:05-04:00", "data": { "order_id": 88231, "order_ref": "SO-100234", "tracking_number": "TRK-1001", "type": "D", "status_id": 16, "route_id": 5120, "driver_id": 42, "driver_name": "Alex", "customer_id": 77, "ready_by_user_id": 3 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.driver.on_duty_changed": { "name": "driver.on_duty_changed", "title": "driver.on_duty_changed", "summary": "A driver went on or off duty.", "description": "Narrowed by `order_lifecycle_events` (empty: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.driver.on_duty_changed" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDF", "event_type": "driver.on_duty_changed", "livemode": true, "occurred_at": "2026-08-17T08:00:00-04:00", "data": { "driver_id": 42, "driver_name": "Alex", "on_duty": true, "changed_at": "2026-08-17T08:00:00-04:00" } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "order_lifecycle_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.driver.location_update": { "name": "driver.location_update", "title": "driver.location_update", "summary": "A driver's position.", "description": "At most one per driver every `driver_location_min_interval_sec` seconds (default 60). `route_id`, `order_id`, `heading`, `speed` and `accuracy` are present only when known.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.driver.location_update" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "OLE-01JABCDG", "event_type": "driver.location_update", "livemode": true, "occurred_at": "2026-08-17T10:00:30-04:00", "data": { "driver_id": 42, "driver_name": "Alex", "latitude": 45.5017, "longitude": -73.5673, "recorded_at": "2026-08-17T10:00:30-04:00", "route_id": 5120, "heading": 90, "speed": 12.5 } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "driver_location_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.device_order.stored": { "name": "device_order.stored", "title": "device_order.stored", "summary": "An item was stored in a device.", "description": "Business recipients only. Narrowed by `device_order_events` (empty: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.device_order_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "DOE-90017", "event_type": "device_order.stored", "livemode": true, "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "device_order": { "id": 5012, "kind": "shipout_pickup", "status": "stored", "next_actor": "recipient", "device_type": "smart_locker", "device_id": 11, "device_name": "LOCKER-A", "grid_code": "A-12", "reference_number": "SR100234", "order_id": 88231, "external_order_id": null, "due_at": "2026-09-18T10:06:00-04:00", "overdue_at": null, "stored_at": "2026-09-15T10:06:00-04:00", "ended_at": null, "removal_reason": null } } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "device_order_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.device_order.collected": { "name": "device_order.collected", "title": "device_order.collected", "summary": "The item was collected.", "description": "Business recipients only. Narrowed by `device_order_events` (empty: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.device_order_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "DOE-90017", "event_type": "device_order.collected", "livemode": true, "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "device_order": { "id": 5012, "kind": "shipout_pickup", "status": "collected", "next_actor": "nobody", "device_type": "smart_locker", "device_id": 11, "device_name": "LOCKER-A", "grid_code": "A-12", "reference_number": "SR100234", "order_id": 88231, "external_order_id": null, "due_at": "2026-09-18T10:06:00-04:00", "overdue_at": null, "stored_at": "2026-09-15T10:06:00-04:00", "ended_at": "2026-09-16T18:40:00-04:00", "removal_reason": null } } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "device_order_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.device_order.removed": { "name": "device_order.removed", "title": "device_order.removed", "summary": "The item was removed by staff.", "description": "Business recipients only. Narrowed by `device_order_events` (empty: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.device_order_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "DOE-90017", "event_type": "device_order.removed", "livemode": true, "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "device_order": { "id": 5012, "kind": "shipout_pickup", "status": "removed", "next_actor": "nobody", "device_type": "smart_locker", "device_id": 11, "device_name": "LOCKER-A", "grid_code": "A-12", "reference_number": "SR100234", "order_id": 88231, "external_order_id": null, "due_at": "2026-09-18T10:06:00-04:00", "overdue_at": "2026-09-18T10:15:00-04:00", "stored_at": "2026-09-15T10:06:00-04:00", "ended_at": "2026-09-19T09:00:00-04:00", "removal_reason": "overdue_return" } } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "device_order_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.device_order.overdue": { "name": "device_order.overdue", "title": "device_order.overdue", "summary": "The item was not collected in time.", "description": "Business recipients only. Narrowed by `device_order_events` (empty: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.device_order_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "DOE-90017", "event_type": "device_order.overdue", "livemode": true, "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "device_order": { "id": 5012, "kind": "shipout_pickup", "status": "stored", "next_actor": "operator", "device_type": "smart_locker", "device_id": 11, "device_name": "LOCKER-A", "grid_code": "A-12", "reference_number": "SR100234", "order_id": 88231, "external_order_id": null, "due_at": "2026-09-18T10:06:00-04:00", "overdue_at": "2026-09-18T10:15:00-04:00", "stored_at": "2026-09-15T10:06:00-04:00", "ended_at": null, "removal_reason": null } } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "device_order_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.device_order.exception_opened": { "name": "device_order.exception_opened", "title": "device_order.exception_opened", "summary": "An exception was opened on the device order.", "description": "Business recipients only. Narrowed by `device_order_events` (empty: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.device_order_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "DOE-90017", "event_type": "device_order.exception_opened", "livemode": true, "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "device_order": { "id": 5012, "kind": "shipout_pickup", "status": "stored", "next_actor": "recipient", "device_type": "smart_locker", "device_id": 11, "device_name": "LOCKER-A", "grid_code": "A-12", "reference_number": "SR100234", "order_id": 88231, "external_order_id": null, "due_at": "2026-09-18T10:06:00-04:00", "overdue_at": null, "stored_at": "2026-09-15T10:06:00-04:00", "ended_at": null, "removal_reason": null }, "exception": { "id": 311, "type": "door_left_open", "severity": "attention", "status": "open", "resolution_action": null } } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "device_order_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "tenant.device_order.exception_resolved": { "name": "device_order.exception_resolved", "title": "device_order.exception_resolved", "summary": "The exception was resolved.", "description": "Business recipients only. Narrowed by `device_order_events` (empty: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tenant" }, "payload": { "$ref": "#/components/schemas/tenant.device_order_event" }, "tags": [ { "name": "tenant" } ], "examples": [ { "name": "sample", "payload": { "event_id": "DOE-90017", "event_type": "device_order.exception_resolved", "livemode": true, "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "device_order": { "id": 5012, "kind": "shipout_pickup", "status": "stored", "next_actor": "recipient", "device_type": "smart_locker", "device_id": 11, "device_name": "LOCKER-A", "grid_code": "A-12", "reference_number": "SR100234", "order_id": 88231, "external_order_id": null, "due_at": "2026-09-18T10:06:00-04:00", "overdue_at": null, "stored_at": "2026-09-15T10:06:00-04:00", "ended_at": null, "removal_reason": null }, "exception": { "id": 311, "type": "door_left_open", "severity": "attention", "status": "resolved", "resolution_action": "marked_ok" } } } } ], "x-superroute-sender": "tenant", "x-superroute-subscribe": "device_order_webhook_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 } }, "partner-locker.partner_locker.delivery.doors_opened": { "name": "partner_locker.delivery.doors_opened", "title": "partner_locker.delivery.doors_opened", "summary": "Compartment doors were opened for a delivery.", "description": "Subscribe with `partner_locker.delivery_doors_opened` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEE", "event_type": "partner_locker.delivery.doors_opened", "livemode": true, "occurred_at": "2026-07-21T14:29:40-04:00", "data": { "delivery_no": "PLD-100234", "external_order_id": "EXT-9001", "status": "awaiting_confirmation", "delivery_mode": "standard", "pickup_code": "483920", "opening": { "attempt_id": 501, "attempt_no": 1, "opened_count": 2, "failed_count": 0, "partial": false, "groups": [ { "shelf_name": "LK-A1", "locker_identifier": "SL-88231", "compartments": [ { "package_sequence": 1, "compartment_number": "12", "grid_id": 5011, "pickup_locker_number": 3, "pickup_locker_code": "LK-A1-3" }, { "package_sequence": 2, "compartment_number": "15", "grid_id": 5014, "pickup_locker_number": 6, "pickup_locker_code": "LK-A1-6" } ] } ] } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_doors_opened", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.partner_locker.delivery.delivered": { "name": "partner_locker.delivery.delivered", "title": "partner_locker.delivery.delivered", "summary": "A delivery was confirmed into the lockers.", "description": "Subscribe with `partner_locker.delivery_delivered` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEF", "event_type": "partner_locker.delivery.delivered", "livemode": true, "occurred_at": "2026-07-21T14:30:00-04:00", "data": { "delivery_no": "PLD-100234", "external_order_id": "EXT-9001", "status": "delivered", "pickup_status": "ready", "requested_package_count": 2, "actual_package_count": 2, "failed_package_count": 0, "picked_up_package_count": 0, "partial_delivery": false, "delivery_mode": "standard", "confirmed_by": "door_close", "split_from_delivery_no": null, "split_delivery_no": null, "pickup_code": "483920", "location": { "id": 12, "name": "Main St Locker" }, "packages": [ { "sequence": 1, "external_package_id": "PKG-1", "status": "confirmed", "shelf_id": 21, "grid_id": 5011, "compartment_number": "12", "pickup_locker_number": 3, "pickup_locker_code": "LK-A1-3" }, { "sequence": 2, "external_package_id": "PKG-2", "status": "confirmed", "shelf_id": 21, "grid_id": 5014, "compartment_number": "15", "pickup_locker_number": 6, "pickup_locker_code": "LK-A1-6" } ] } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_delivered", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.partner_locker.pickup.completed": { "name": "partner_locker.pickup.completed", "title": "partner_locker.pickup.completed", "summary": "The recipient collected the delivery.", "description": "Subscribe with `partner_locker.delivery_picked_up` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEG", "event_type": "partner_locker.pickup.completed", "livemode": true, "occurred_at": "2026-07-22T09:12:00-04:00", "data": { "delivery_no": "PLD-100234", "status": "picked_up", "pickup_status": "completed", "picked_up_package_count": 2 } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_picked_up", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.partner_locker.delivery.failed": { "name": "partner_locker.delivery.failed", "title": "partner_locker.delivery.failed", "summary": "A delivery failed.", "description": "Subscribe with `partner_locker.delivery_failed` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEH", "event_type": "partner_locker.delivery.failed", "livemode": true, "occurred_at": "2026-07-21T14:35:00-04:00", "data": { "delivery_no": "PLD-100235", "status": "failed", "failed_package_count": 1, "packages": [ { "sequence": 1, "status": "failed", "failure_code": "NO_CAPACITY" } ] } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_failed", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.partner_locker.delivery.expired": { "name": "partner_locker.delivery.expired", "title": "partner_locker.delivery.expired", "summary": "A delivery expired.", "description": "Subscribe with `partner_locker.delivery_expired` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEI", "event_type": "partner_locker.delivery.expired", "livemode": true, "occurred_at": "2026-07-24T00:05:00-04:00", "data": { "delivery_no": "PLD-100236", "status": "expired" } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_expired", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.partner_locker.delivery.cancelled": { "name": "partner_locker.delivery.cancelled", "title": "partner_locker.delivery.cancelled", "summary": "A delivery was cancelled.", "description": "Subscribe with `partner_locker.delivery_cancelled` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEJ", "event_type": "partner_locker.delivery.cancelled", "livemode": true, "occurred_at": "2026-07-21T15:00:00-04:00", "data": { "delivery_no": "PLD-100237", "status": "cancelled" } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_cancelled", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.partner_locker.delivery.correction_reopened": { "name": "partner_locker.delivery.correction_reopened", "title": "partner_locker.delivery.correction_reopened", "summary": "Compartments were reopened to correct a delivery.", "description": "Subscribe with `partner_locker.delivery_correction_reopened` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEK", "event_type": "partner_locker.delivery.correction_reopened", "livemode": true, "occurred_at": "2026-07-21T14:31:05-04:00", "data": { "delivery_no": "PLD-100234", "status": "delivered", "correction": { "channel": "device", "reopened_count": 2, "failed_count": 0, "compartments": [ { "compartment_number": "A03", "package_sequence": 1, "grid_id": 5011, "pickup_locker_number": 3, "pickup_locker_code": "LK-A1-3" }, { "compartment_number": "A04", "package_sequence": 2, "grid_id": 5014, "pickup_locker_number": 6, "pickup_locker_code": "LK-A1-6" } ] } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_correction_reopened", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.partner_locker.delivery.code_rotated": { "name": "partner_locker.delivery.code_rotated", "title": "partner_locker.delivery.code_rotated", "summary": "An access or pickup code was replaced.", "description": "Received only by endpoints subscribed to all events: this type cannot be selected by name today.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEM", "event_type": "partner_locker.delivery.code_rotated", "livemode": true, "occurred_at": "2026-08-11T09:15:00-04:00", "data": { "delivery_no": "PLD-100234", "external_order_id": "EXT-9001", "status": "active", "rotation": { "code_type": "access", "rotated_at": "2026-08-11T09:15:00-04:00", "recipient_notified": false } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.delivery_code_rotated", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.carrier_package.distribution.created": { "name": "carrier_package.distribution.created", "title": "carrier_package.distribution.created", "summary": "A carrier package was put on a distribution order.", "description": "Subscribe with `partner_locker.carrier_package_distributed` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEN", "event_type": "carrier_package.distribution.created", "livemode": true, "occurred_at": "2026-09-20T10:12:00-04:00", "data": { "package_no": "12-77", "carrier_reference_number": "1Z999AA10123456784", "member_number": null, "carrier_order_id": null, "batch": "B-1", "distribution": { "order_id": 9002, "order_ref": "DIST-276-703-20260920-1", "status": "pending_route" }, "origin": { "id": 276, "name": "Central" }, "destination": { "id": 703, "name": "Point A" } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.carrier_package_distributed", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.carrier_package.distribution.loaded": { "name": "carrier_package.distribution.loaded", "title": "carrier_package.distribution.loaded", "summary": "A carrier package was loaded for distribution.", "description": "Subscribe with `partner_locker.carrier_package_loaded` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEN", "event_type": "carrier_package.distribution.loaded", "livemode": true, "occurred_at": "2026-09-20T10:12:00-04:00", "data": { "package_no": "12-77", "carrier_reference_number": "1Z999AA10123456784", "member_number": null, "carrier_order_id": null, "batch": "B-1", "distribution": { "order_id": 9002, "order_ref": "DIST-276-703-20260920-1", "status": "in_transit", "loaded_at": "2026-09-20T10:12:00-04:00" }, "origin": { "id": 276, "name": "Central" }, "destination": { "id": 703, "name": "Point A" } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.carrier_package_loaded", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.carrier_package.distribution.delivered": { "name": "carrier_package.distribution.delivered", "title": "carrier_package.distribution.delivered", "summary": "A carrier package reached its destination.", "description": "Subscribe with `partner_locker.carrier_package_delivered` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEN", "event_type": "carrier_package.distribution.delivered", "livemode": true, "occurred_at": "2026-09-20T10:12:00-04:00", "data": { "package_no": "12-77", "carrier_reference_number": "1Z999AA10123456784", "member_number": null, "carrier_order_id": null, "batch": "B-1", "distribution": { "order_id": 9002, "order_ref": "DIST-276-703-20260920-1", "status": "delivered", "delivered_at": "2026-09-20T13:40:00-04:00" }, "origin": { "id": 276, "name": "Central" }, "destination": { "id": 703, "name": "Point A" } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.carrier_package_delivered", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.carrier_package.distribution.shelved": { "name": "carrier_package.distribution.shelved", "title": "carrier_package.distribution.shelved", "summary": "A carrier package was shelved at its destination.", "description": "Subscribe with `partner_locker.carrier_package_shelved` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEN", "event_type": "carrier_package.distribution.shelved", "livemode": true, "occurred_at": "2026-09-20T10:12:00-04:00", "data": { "package_no": "12-77", "carrier_reference_number": "1Z999AA10123456784", "member_number": null, "carrier_order_id": null, "batch": "B-1", "distribution": { "order_id": 9002, "order_ref": "DIST-276-703-20260920-1", "status": "shelved", "shelved_at": "2026-09-20T13:55:00-04:00" }, "destination": { "id": 703, "name": "Point A" }, "location": { "grid_id": 5011, "grid_code": "L-A-01", "shelf_code": "L-A" } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.carrier_package_shelved", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "partner-locker.carrier_package.distribution.removed": { "name": "carrier_package.distribution.removed", "title": "carrier_package.distribution.removed", "summary": "A carrier package was taken off its distribution order.", "description": "Subscribe with `partner_locker.carrier_package_distribution_removed` in the endpoint's event types (none selected: all).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.partner-locker" }, "payload": { "$ref": "#/components/schemas/partner-locker.event" }, "tags": [ { "name": "partner-locker" } ], "examples": [ { "name": "sample", "payload": { "event_id": "PLE-01JABCDEN", "event_type": "carrier_package.distribution.removed", "livemode": true, "occurred_at": "2026-09-20T10:12:00-04:00", "data": { "package_no": "12-77", "carrier_reference_number": "1Z999AA10123456784", "member_number": null, "carrier_order_id": null, "batch": "B-1", "distribution": { "order_id": 9002, "order_ref": "DIST-276-703-20260920-1", "status": "removed", "reason": "removed" }, "origin": { "id": 276, "name": "Central" }, "destination": { "id": 703, "name": "Point A" } } } } ], "x-superroute-sender": "partner-locker", "x-superroute-subscribe": "partner_locker.carrier_package_distribution_removed", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "tpd.delivery.assignment.created": { "name": "delivery.assignment.created", "title": "delivery.assignment.created", "summary": "An order was assigned to the provider.", "description": "Subscribe with this type in the endpoint's event types.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tpd" }, "payload": { "$ref": "#/components/schemas/tpd.assignment_event" }, "tags": [ { "name": "tpd" } ], "examples": [ { "name": "sample", "payload": { "event_id": "TPDE-01JABCDEA", "event_type": "delivery.assignment.created", "occurred_at": "2026-07-30T09:15:00-04:00", "data": { "assignment_no": "TPD20260730091500ABC123", "assignment_status": "assigned", "order_id": 88231, "order_ref": "SO-100234", "packages": [ { "tracking_number": "TRK-1001", "external_tracking_number": "EXT-1001" } ] } } } ], "x-superroute-sender": "tpd", "x-superroute-subscribe": "delivery.assignment.created", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "tpd.delivery.assignment.handed_over": { "name": "delivery.assignment.handed_over", "title": "delivery.assignment.handed_over", "summary": "The provider accepted the hand-over.", "description": "Subscribe with this type in the endpoint's event types.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tpd" }, "payload": { "$ref": "#/components/schemas/tpd.assignment_event" }, "tags": [ { "name": "tpd" } ], "examples": [ { "name": "sample", "payload": { "event_id": "TPDE-01JABCDEB", "event_type": "delivery.assignment.handed_over", "occurred_at": "2026-07-30T14:02:00-04:00", "data": { "assignment_no": "TPD20260730091500ABC123", "assignment_status": "accepted", "order_id": 88231, "order_ref": "SO-100234", "external_order_number": "CARRIER-556", "packages": [ { "tracking_number": "TRK-1001", "external_tracking_number": "EXT-1001" } ] } } } ], "x-superroute-sender": "tpd", "x-superroute-subscribe": "delivery.assignment.handed_over", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "tpd.delivery.assignment.cancelled": { "name": "delivery.assignment.cancelled", "title": "delivery.assignment.cancelled", "summary": "The assignment was cancelled.", "description": "Subscribe with this type in the endpoint's event types.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tpd" }, "payload": { "$ref": "#/components/schemas/tpd.assignment_event" }, "tags": [ { "name": "tpd" } ], "examples": [ { "name": "sample", "payload": { "event_id": "TPDE-01JABCDEC", "event_type": "delivery.assignment.cancelled", "occurred_at": "2026-07-30T16:40:00-04:00", "data": { "assignment_no": "TPD20260730091500ABC123", "assignment_status": "cancelled", "order_id": 88231, "order_ref": "SO-100234", "reason": "cancelled" } } } ], "x-superroute-sender": "tpd", "x-superroute-subscribe": "delivery.assignment.cancelled", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "tpd.delivery.assignment.partial_delivered": { "name": "delivery.assignment.partial_delivered", "title": "delivery.assignment.partial_delivered", "summary": "Some packages of the assignment were delivered.", "description": "Subscribe with this type in the endpoint's event types.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.tpd" }, "payload": { "$ref": "#/components/schemas/tpd.assignment_event" }, "tags": [ { "name": "tpd" } ], "examples": [ { "name": "sample", "payload": { "event_id": "TPDE-01JABCDED", "event_type": "delivery.assignment.partial_delivered", "occurred_at": "2026-07-31T11:20:00-04:00", "data": { "assignment_no": "TPD20260730091500ABC123", "assignment_status": "accepted", "order_id": 88231, "order_ref": "SO-100234", "packages": [ { "tracking_number": "TRK-1001", "outcome": "delivered" }, { "tracking_number": "TRK-1002" } ], "legs": [ { "leg_no": 1, "package_id": 4451, "external_order_number": "CARRIER-556", "push_status": "pushed", "status": "accepted", "outcome": "delivered" }, { "leg_no": 2, "package_id": 4452, "external_order_number": "CARRIER-557", "push_status": "pushed", "status": "accepted" } ] } } } ], "x-superroute-sender": "tpd", "x-superroute-subscribe": "delivery.assignment.partial_delivered", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 } }, "loading-plan.loading_plan.solve_started": { "name": "loading_plan.solve_started", "title": "loading_plan.solve_started", "summary": "The solver started.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.loading-plan" }, "payload": { "$ref": "#/components/schemas/loading-plan.event" }, "tags": [ { "name": "loading-plan" } ], "examples": [ { "name": "sample", "payload": { "event_id": "4f6c2a1e-8b3d-4c5a-9e7f-1a2b3c4d5e6f", "event_type": "loading_plan.solve_started", "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "request_id": "req-7781", "loading_plan_id": 310, "solve_run_id": 1204, "status": "solving", "status_path": "/api/v1/loading-plans/310/solve-runs/1204" } } } ], "x-superroute-sender": "loading-plan", "x-superroute-subscribe": "callback_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors. Any other status ends delivery.", "timeout_seconds": 10 } }, "loading-plan.loading_plan.candidates_ready": { "name": "loading_plan.candidates_ready", "title": "loading_plan.candidates_ready", "summary": "Candidate plans are ready.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.loading-plan" }, "payload": { "$ref": "#/components/schemas/loading-plan.event" }, "tags": [ { "name": "loading-plan" } ], "examples": [ { "name": "sample", "payload": { "event_id": "4f6c2a1e-8b3d-4c5a-9e7f-1a2b3c4d5e6f", "event_type": "loading_plan.candidates_ready", "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "request_id": "req-7781", "loading_plan_id": 310, "solve_run_id": 1204, "status": "candidates_ready", "status_path": "/api/v1/loading-plans/310/solve-runs/1204" } } } ], "x-superroute-sender": "loading-plan", "x-superroute-subscribe": "callback_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors. Any other status ends delivery.", "timeout_seconds": 10 } }, "loading-plan.loading_plan.finalized": { "name": "loading_plan.finalized", "title": "loading_plan.finalized", "summary": "A candidate was finalized.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.loading-plan" }, "payload": { "$ref": "#/components/schemas/loading-plan.event" }, "tags": [ { "name": "loading-plan" } ], "examples": [ { "name": "sample", "payload": { "event_id": "4f6c2a1e-8b3d-4c5a-9e7f-1a2b3c4d5e6f", "event_type": "loading_plan.finalized", "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "request_id": "req-7781", "loading_plan_id": 310, "solve_run_id": 1204, "status": "finalized", "status_path": "/api/v1/loading-plans/310/solve-runs/1204", "candidate_id": 5521 } } } ], "x-superroute-sender": "loading-plan", "x-superroute-subscribe": "callback_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors. Any other status ends delivery.", "timeout_seconds": 10 } }, "loading-plan.loading_plan.validation_failed": { "name": "loading_plan.validation_failed", "title": "loading_plan.validation_failed", "summary": "The input failed validation.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.loading-plan" }, "payload": { "$ref": "#/components/schemas/loading-plan.event" }, "tags": [ { "name": "loading-plan" } ], "examples": [ { "name": "sample", "payload": { "event_id": "4f6c2a1e-8b3d-4c5a-9e7f-1a2b3c4d5e6f", "event_type": "loading_plan.validation_failed", "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "request_id": "req-7781", "loading_plan_id": 310, "solve_run_id": 1204, "status": "validation_failed", "status_path": "/api/v1/loading-plans/310/solve-runs/1204", "error_code": "VEHICLE_CAPACITY_EXCEEDED" } } } ], "x-superroute-sender": "loading-plan", "x-superroute-subscribe": "callback_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors. Any other status ends delivery.", "timeout_seconds": 10 } }, "loading-plan.loading_plan.solve_failed": { "name": "loading_plan.solve_failed", "title": "loading_plan.solve_failed", "summary": "The solver failed.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.loading-plan" }, "payload": { "$ref": "#/components/schemas/loading-plan.event" }, "tags": [ { "name": "loading-plan" } ], "examples": [ { "name": "sample", "payload": { "event_id": "4f6c2a1e-8b3d-4c5a-9e7f-1a2b3c4d5e6f", "event_type": "loading_plan.solve_failed", "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "request_id": "req-7781", "loading_plan_id": 310, "solve_run_id": 1204, "status": "solve_failed", "status_path": "/api/v1/loading-plans/310/solve-runs/1204", "error_code": "SOLVER_TIMEOUT" } } } ], "x-superroute-sender": "loading-plan", "x-superroute-subscribe": "callback_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors. Any other status ends delivery.", "timeout_seconds": 10 } }, "loading-plan.loading_plan.cancelled": { "name": "loading_plan.cancelled", "title": "loading_plan.cancelled", "summary": "The solve was cancelled.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.loading-plan" }, "payload": { "$ref": "#/components/schemas/loading-plan.event" }, "tags": [ { "name": "loading-plan" } ], "examples": [ { "name": "sample", "payload": { "event_id": "4f6c2a1e-8b3d-4c5a-9e7f-1a2b3c4d5e6f", "event_type": "loading_plan.cancelled", "occurred_at": "2026-09-15T10:06:00-04:00", "data": { "request_id": "req-7781", "loading_plan_id": 310, "solve_run_id": 1204, "status": "cancelled", "status_path": "/api/v1/loading-plans/310/solve-runs/1204" } } } ], "x-superroute-sender": "loading-plan", "x-superroute-subscribe": "callback_url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors. Any other status ends delivery.", "timeout_seconds": 10 } }, "open-platform.endpoint.verify": { "name": "endpoint.verify", "title": "endpoint.verify", "summary": "Challenge sent before the first callback to a new endpoint.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.open-platform" }, "payload": { "$ref": "#/components/schemas/open-platform.endpoint.verify" }, "tags": [ { "name": "open-platform" } ], "examples": [ { "name": "sample", "payload": { "event": "endpoint.verify", "challenge": "c_8f2c1d4b9a7e6f50", "occurred_at": "2026-09-15T14:05:00Z" } } ], "x-superroute-sender": "open-platform", "x-superroute-subscribe": "callback.url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "open-platform.job.queued": { "name": "job.queued", "title": "job.queued", "summary": "The job was queued.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.open-platform" }, "payload": { "$ref": "#/components/schemas/open-platform.job_event" }, "tags": [ { "name": "open-platform" } ], "examples": [ { "name": "sample", "payload": { "event": "job.queued", "delivery_id": "dlv_01jabcde0000000000000000", "job_id": "job_01jabcde0000000000000000", "request_id": "req-7781", "capability": "routing.optimize", "occurred_at": "2026-09-15T14:06:00Z", "attempt": 1, "status": "queued" } } ], "x-superroute-sender": "open-platform", "x-superroute-subscribe": "callback.url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "open-platform.job.succeeded": { "name": "job.succeeded", "title": "job.succeeded", "summary": "The job succeeded.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.open-platform" }, "payload": { "$ref": "#/components/schemas/open-platform.job.succeeded" }, "tags": [ { "name": "open-platform" } ], "examples": [ { "name": "sample", "payload": { "event": "job.succeeded", "delivery_id": "dlv_01jabcde0000000000000000", "job_id": "job_01jabcde0000000000000000", "request_id": "req-7781", "capability": "routing.optimize", "occurred_at": "2026-09-15T14:06:00Z", "attempt": 1, "status": "succeeded", "result_url": "https://open.superroute.ca/v1/jobs/job_01jabcde0000000000000000/result", "result_expires_at": "2026-09-22T14:06:00Z" } } ], "x-superroute-sender": "open-platform", "x-superroute-subscribe": "callback.url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "open-platform.job.failed": { "name": "job.failed", "title": "job.failed", "summary": "The job failed.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.open-platform" }, "payload": { "$ref": "#/components/schemas/open-platform.job.failed" }, "tags": [ { "name": "open-platform" } ], "examples": [ { "name": "sample", "payload": { "event": "job.failed", "delivery_id": "dlv_01jabcde0000000000000000", "job_id": "job_01jabcde0000000000000000", "request_id": "req-7781", "capability": "routing.optimize", "occurred_at": "2026-09-15T14:06:00Z", "attempt": 1, "status": "failed", "error": { "code": "SOLVER_TIMEOUT", "message": "The solver did not finish within the time limit." } } } ], "x-superroute-sender": "open-platform", "x-superroute-subscribe": "callback.url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "open-platform.job.cancelled": { "name": "job.cancelled", "title": "job.cancelled", "summary": "The job was cancelled.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.open-platform" }, "payload": { "$ref": "#/components/schemas/open-platform.job_event" }, "tags": [ { "name": "open-platform" } ], "examples": [ { "name": "sample", "payload": { "event": "job.cancelled", "delivery_id": "dlv_01jabcde0000000000000000", "job_id": "job_01jabcde0000000000000000", "request_id": "req-7781", "capability": "routing.optimize", "occurred_at": "2026-09-15T14:06:00Z", "attempt": 1, "status": "cancelled" } } ], "x-superroute-sender": "open-platform", "x-superroute-subscribe": "callback.url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.subscription.verify": { "name": "subscription.verify", "title": "subscription.verify", "summary": "The subscribe-time challenge; echo `data.challenge` back.", "description": "Sent once, while POST /subscriptions is being answered. The subscription exists only if the echo matches.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.subscription.verify" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zk", "sent_at": "2026-09-24T17:00:00-04:00", "body": { "event": "subscription.verify", "data": { "challenge": "q7VgW2xL9rT4mB6cD8fH1jK5nP0sU3yZa2e4g6i8" } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.handoff.accepted": { "name": "handoff.accepted", "title": "handoff.accepted", "summary": "An offered handoff was accepted; the order exists now.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.handoff.accepted" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zd", "sent_at": "2026-09-24T18:00:00-04:00", "body": { "event": "handoff.accepted", "data": { "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "status": "accepted", "tracking_numbers": [ "SR100200300" ] } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.handoff.rejected": { "name": "handoff.rejected", "title": "handoff.rejected", "summary": "An offered handoff was rejected.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.handoff.rejected" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zg", "sent_at": "2026-09-24T18:10:00-04:00", "body": { "event": "handoff.rejected", "data": { "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "status": "rejected", "reason": "No van that day" } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.handoff.expired": { "name": "handoff.expired", "title": "handoff.expired", "summary": "An offered handoff passed its expiry unanswered.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.handoff.expired" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zf", "sent_at": "2026-09-25T18:00:00-04:00", "body": { "event": "handoff.expired", "data": { "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "status": "expired" } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.handoff.cancelled": { "name": "handoff.cancelled", "title": "handoff.cancelled", "summary": "A handoff was cancelled.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.handoff.expired" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1ze", "sent_at": "2026-09-24T18:20:00-04:00", "body": { "event": "handoff.cancelled", "data": { "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "status": "cancelled" } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.amendment.accepted": { "name": "amendment.accepted", "title": "amendment.accepted", "summary": "An amendment proposal was accepted; any price delta became a settlement line.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.amendment.accepted" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zb", "sent_at": "2026-09-24T19:05:00-04:00", "body": { "event": "amendment.accepted", "data": { "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "amendment_id": 7, "status": "accepted", "price_delta": 4.5, "currency": "CAD", "answer_note": "Rebooked for the morning run" } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.amendment.rejected": { "name": "amendment.rejected", "title": "amendment.rejected", "summary": "An amendment proposal was rejected.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.amendment.rejected" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zc", "sent_at": "2026-09-24T19:06:00-04:00", "body": { "event": "amendment.rejected", "data": { "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "amendment_id": 8, "status": "rejected", "answer_note": "Already loaded" } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.handoff.tracking": { "name": "handoff.tracking", "title": "handoff.tracking", "summary": "One OTEP tracking event on a handed-over order.", "description": "The timeline pulled from GET /handoffs/{ref}/timeline stays the record.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.handoff.tracking" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zh", "sent_at": "2026-09-24T21:15:00-04:00", "body": { "event": "handoff.tracking", "data": { "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "event": { "status_code": "delivered", "occurred_at": "2026-09-24T21:12:00-04:00" } } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "ohp.settlement_line.created": { "name": "settlement_line.created", "title": "settlement_line.created", "summary": "A new settlement line exists for a handoff.", "description": "The lines pulled from GET /settlement-lines stay the record.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.ohp" }, "payload": { "$ref": "#/components/schemas/ohp.settlement_line.created" }, "tags": [ { "name": "ohp" } ], "examples": [ { "name": "sample", "payload": { "ohp_version": "0.2", "profile": "parcel", "message_id": "opd_01jaq2f8m0n3v6x9r2k5w8y1zj", "sent_at": "2026-09-25T09:00:00-04:00", "body": { "event": "settlement_line.created", "data": { "line_id": "12", "handoff_ref": "rsb_9f2c1ab4de67f8a1b2c3d4e5", "kind": "adjustment", "amount": 4.5, "currency": "CAD", "reason": "Reweigh: billed 3.1 kg vs quoted 2.4 kg", "status": "accepted" } } } } ], "x-superroute-sender": "ohp", "x-superroute-subscribe": "POST /api/v1/ohp/subscriptions `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 } }, "dataset.test": { "name": "test", "title": "test", "summary": "Test delivery from the dataset webhook's test button.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.test" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "test", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "test": true, "message": "This is a test webhook from Superroute", "webhook_id": 7, "webhook_name": "Warehouse sync" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "url", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } }, "dataset.record_created": { "name": "record_created", "title": "record_created", "summary": "A record was created by a user (web, API, bulk API). Imports, copies and merges send import_completed instead.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.record_created" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "record_created", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "record": { "id": 88213, "group_id": 12, "dataset_id": 41, "row_number": 57, "data": { "store_code": "MTL-017", "name": "Plateau", "address": "4200 Rue Saint-Denis", "city": "Montreal", "postcode": "H2J 2K8" }, "address_combined": "4200 Rue Saint-Denis Montreal H2J 2K8", "latitude": 45.5226, "longitude": -73.5821, "geocode_status": "success", "validation_status": "valid", "validation_errors": null, "created_at": "2026-09-15T10:02:11-04:00", "updated_at": "2026-09-15T10:05:40-04:00" }, "occurred_at": "2026-09-15T10:05:59-04:00" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "dataset webhook `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } }, "dataset.record_updated": { "name": "record_updated", "title": "record_updated", "summary": "A record was edited by a user (web or API). System changes (geocoding, computed columns, validation status) are not sent.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.record_updated" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "record_updated", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "record": { "id": 88213, "group_id": 12, "dataset_id": 41, "row_number": 57, "data": { "store_code": "MTL-017", "name": "Plateau", "address": "4200 Rue Saint-Denis", "city": "Montreal", "postcode": "H2J 2K8" }, "address_combined": "4200 Rue Saint-Denis Montreal H2J 2K8", "latitude": 45.5226, "longitude": -73.5821, "geocode_status": "success", "validation_status": "valid", "validation_errors": null, "created_at": "2026-09-15T10:02:11-04:00", "updated_at": "2026-09-15T10:05:40-04:00" }, "changed": [ "name" ], "previous": { "name": "Plateau Mont-Royal" }, "occurred_at": "2026-09-15T10:05:59-04:00" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "dataset webhook `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } }, "dataset.record_deleted": { "name": "record_deleted", "title": "record_deleted", "summary": "A record was deleted by a user (web, API, bulk, duplicate resolution); `record` is its last state. Deleting a whole group or dataset sends nothing per record.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.record_created" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "record_deleted", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "record": { "id": 88213, "group_id": 12, "dataset_id": 41, "row_number": 57, "data": { "store_code": "MTL-017", "name": "Plateau", "address": "4200 Rue Saint-Denis", "city": "Montreal", "postcode": "H2J 2K8" }, "address_combined": "4200 Rue Saint-Denis Montreal H2J 2K8", "latitude": 45.5226, "longitude": -73.5821, "geocode_status": "success", "validation_status": "valid", "validation_errors": null, "created_at": "2026-09-15T10:02:11-04:00", "updated_at": "2026-09-15T10:05:40-04:00" }, "occurred_at": "2026-09-15T10:05:59-04:00" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "dataset webhook `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } }, "dataset.import_completed": { "name": "import_completed", "title": "import_completed", "summary": "A batch of records reached a group: a file import, a scheduled import, a copy or a merge. Sent on failure too.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.import_completed" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "import_completed", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "group_id": 12, "dataset_id": 41, "source": "file", "status": "geocoding", "created": 1250, "updated": 0, "skipped": 0, "errors": 3, "invalid": 14, "error": null, "occurred_at": "2026-09-15T10:05:59-04:00" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "dataset webhook `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } }, "dataset.geocode_completed": { "name": "geocode_completed", "title": "geocode_completed", "summary": "Geocoding of a whole group finished (after an import, a group regeocode or records added through the API). Single-record geocoding sends nothing.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.geocode_completed" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "geocode_completed", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "group_id": 12, "dataset_id": 41, "success": 1231, "failed": 16, "skipped": 3, "pending": 0, "occurred_at": "2026-09-15T10:05:59-04:00" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "dataset webhook `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } }, "dataset.validation_failed": { "name": "validation_failed", "title": "validation_failed", "summary": "A group validation run ended with invalid or skipped records.", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.validation_failed" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "validation_failed", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "group_id": 12, "dataset_id": 41, "valid": 1236, "invalid": 14, "skipped": 0, "failures": [ { "record_id": 88213, "errors": { "postcode": [ { "rule": "regex", "message": "Postcode format is invalid", "on_fail": "flag" } ] } } ], "truncated": false, "occurred_at": "2026-09-15T10:05:59-04:00" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "dataset webhook `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } }, "dataset.duplicate_found": { "name": "duplicate_found", "title": "duplicate_found", "summary": "Duplicates were found in a group: by the duplicate check (`detect`, with pairs) or while merging (`merge`, count only).", "contentType": "application/json", "headers": { "$ref": "#/components/schemas/headers.dataset" }, "payload": { "$ref": "#/components/schemas/dataset.duplicate_found" }, "tags": [ { "name": "dataset" } ], "examples": [ { "name": "sample", "payload": { "event": "duplicate_found", "timestamp": "2026-09-15T10:06:00-04:00", "dataset_id": 41, "data": { "group_id": 12, "dataset_id": 41, "source": "detect", "count": 2, "pairs": [ { "original_id": 88001, "duplicate_id": 88213 }, { "original_id": 88040, "duplicate_id": 88230 } ], "truncated": false, "occurred_at": "2026-09-15T10:05:59-04:00" } } } ], "x-superroute-sender": "dataset", "x-superroute-subscribe": "dataset webhook `events`", "x-superroute-body": "object", "x-superroute-formats": [ "native", "ce_binary", "ce_structured" ], "x-superroute-signatures": [ "native", "standard_webhooks" ], "x-superroute-retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 } } } }, "x-superroute-senders": { "tenant": { "title": "Tenant webhooks", "description": "Events for a business or one of its customers, sent to the URLs configured in that recipient's webhook settings (settings page, customer edit page, or `PUT /api/v1/webhook-settings`). A URL setting may hold several comma-separated URLs; each receives every event of that setting. Delivered by a queued job.", "retry": { "attempts": 5, "delays_seconds": [ 10, 100, 1000, 10000 ], "retry_on": "Any response other than 2xx, and connection errors.", "timeout_seconds": 3 }, "notes": "TLS certificates are not verified unless the recipient sets `webhook_verify_ssl` to 1. The body is JSON encoded with default flags (`/` is escaped as `\\/`, non-ASCII as `\\uXXXX`); verify signatures against the raw bytes received." }, "partner-locker": { "title": "Partner locker deliveries", "description": "Events about deliveries into a partner's smart lockers and carrier package distribution, sent to the webhook endpoint configured for that partner. Each event is stored and delivered from an outbox.", "retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 }, "notes": "The body is JSON encoded with unescaped slashes and Unicode." }, "tpd": { "title": "Third-party delivery assignments", "description": "Events about orders assigned to a third-party delivery provider, sent to the webhook endpoint configured for that provider. Same outbox and signature recipe as partner locker deliveries.", "retry": { "attempts": 7, "delays_seconds": [ 30, 120, 600, 3600, 21600, 86400 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors; up to 10% jitter is added. Any other status ends delivery.", "timeout_seconds": 10 }, "notes": "The body is JSON encoded with unescaped slashes and Unicode." }, "loading-plan": { "title": "Loading plan callbacks", "description": "Progress of one loading-plan solve, sent to the `callback_url` given in `POST /api/v1/loading-plans/{plan}/solve`. Each event type is delivered at most once per solve run.", "retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "HTTP 408, 425, 429, 5xx and connection errors. Any other status ends delivery.", "timeout_seconds": 10 }, "notes": "The body is JSON encoded with unescaped slashes and Unicode." }, "open-platform": { "title": "Open Platform job callbacks", "description": "Status of one asynchronous Open Platform job, sent to the `callback.url` given with the request after that endpoint passed an `endpoint.verify` challenge. `callback.events` narrows which job events are sent.", "retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 }, "notes": "The body is rebuilt on every attempt, so `attempt` changes between attempts. `occurred_at` is the time of the attempt; for a job whose callback asked for CloudEvents or Standard Webhooks it is the time of the event and stays the same. It is JSON encoded with unescaped slashes and Unicode." }, "ohp": { "title": "OHP push", "description": "Open Order Handoff Protocol L3 push (docs/standards/ohp.md §3.8): lifecycle changes, OTEP tracking events and new settlement lines for the handoffs of one grantor–grantee pair, sent to the endpoints an OHP token holder subscribed via POST /api/v1/ohp/subscriptions. Every body is the OHP envelope; `message_id` is stable across retries and is what a receiver dedupes on. Pull stays the record — a missed push loses nothing.", "retry": { "attempts": 5, "delays_seconds": [ 60, 300, 1800, 7200 ], "retry_on": "Any response except HTTP 400, 401, 403, 404, 410 and 422, and connection errors.", "timeout_seconds": 10 }, "notes": "The body is rebuilt on every attempt (`sent_at` and the timestamp change; `message_id` does not). It is JSON encoded with unescaped slashes and Unicode. `subscription.verify` is sent once, at subscribe time, and must be echoed." }, "dataset": { "title": "Dataset webhooks", "description": "Dataset events, sent to the URL of a dataset webhook that subscribed to them in its `events` list; `test` comes from the webhook's test button. Each event gets a UUID that stays the same across its retries.", "retry": { "attempts": 3, "delays_seconds": [ 60, 120 ], "retry_on": "Any failure, until the webhook's `retry_count` attempts are used (default 3; the delay is 2^attempt × 30 s).", "timeout_seconds": 30 }, "notes": "Headers configured on the webhook are sent as well." } } }