{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"“Deep” API Integration (“Push”)","siteUrl":"https://docs.bettermile.com","jsonLd":{"@context":"https://schema.org","@type":"Organization","name":"Bettermile","url":"https://bettermile.com","logo":"https://docs.bettermile.com/images/logo.png"},"description":"Requirements and technical integration for building a fully custom tracking experience using Bettermile's push subscription API."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"deep-api-integration-push","__idx":0},"children":["“Deep” API Integration (“Push”)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["By “deep” integrating the real-time tracking experience you are taking full responsibility. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The complexity of this integration must be fully understood."]}," All necessary information and features must be considered."," ","Additionally, the integration must be updated promptly when Bettermile provides new features."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bettermile offers a subscription service (“Push” via webhook) to provide you with all the needed data and in-time updates to enable you to create a unique and wholesome tracking experience."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":1},"children":["Requirements"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You need to consider ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["all"]}," information and features when “deeply” integrating:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ETA Time window"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The number of Remaining stops"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The time remaining for delivery"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The driver's and consignee's location on a map"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The shipper and consignee information"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Proactive communication on time window changes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Deposit permissions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Redirections to a neighbor"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Redirections  to a Parcel Shop or Locker"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send a note to the drive"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must be able to provide a state-of-the-art tracking experience"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must be able to track the overall performance and the detailed usage of the user interface and features"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must offer a rating for the consignees (More details in next section)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You must regularly update the user interface to meet the latest state-of-the-art standards and stay best-in-class consistently"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"technical-integration","__idx":2},"children":["Technical Integration"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use Availability Webhook to understand when the parcel becomes available for tracking."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The integration must",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Support retry mechanisms and idempotency to handle transient failures without data duplication or loss"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure 99.9% uptime and processing of webhook events within 500 milliseconds to avoid piled-up messaging queues that would delay invites to consignees"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Industry incident management best practices including monitoring, alerting, and duty shifts during peak times"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use the subscription service to get tracking information for the parcel. This includes shipper and consignee address, delivery information, ETA timestamps, and much more"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Implement features to ensure high UX"]}]}]},"headings":[{"value":"“Deep” API Integration (“Push”)","id":"deep-api-integration-push","depth":1},{"value":"Requirements","id":"requirements","depth":2},{"value":"Technical Integration","id":"technical-integration","depth":2}],"frontmatter":{"title":"“Deep” API Integration (“Push”)","rbac":{"anonymous":"read","authenticated":"read"},"seo":{"description":"Requirements and technical integration for building a fully custom tracking experience using Bettermile's push subscription API.","title":"“Deep” API Integration (“Push”)"}},"lastModified":"2026-10-01T11:41:53.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/tracking/shadow-orchestrate/user-interface/deep-integration","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}