{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["tabs","tab"]},"type":"markdown"},"seo":{"title":"End-to-End Webhook Setup","description":"itney Bowes Shipping API, developers can integrate features such as comparing shipping rates from multiple carriers, creating and purchasing shipping labels, tracking packages, scheduling pickups, managing returns, and accessing other shipping features. These APIs also offers a variety of shipping services, including international shipping and multi-carrier rate shopping, which allows developers to choose the best carrier and rate for each shipment."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"end-to-end-webhook-setup","__idx":0},"children":["End-to-End Webhook Setup"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide provides an overview of how to use Pitney Bowes webhook services for tracking events. Pitney Bowes supports tracking for shipments processed both ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["on-platform"]}," (shipments handled by Pitney Bowes) and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["off-platform"]}," (shipments handled by other platforms)."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["on-platform"]},": Shipments created using Pitney Bowes APIs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["off-platform"]},": shipments created outside Pitney Bowes but tracked through Pitney Bowes"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"on-platform-tracking-events","__idx":1},"children":["On-Platform Tracking Events"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"overview","__idx":2},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These events are generated for shipments processed by Pitney Bowes. Developers can configure a webhook to receive tracking events automatically. Tracking numbers for on-platform shipments are automatically subscribed, and once a webhook is set up, related events are broadcast automatically."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setup-instructions","__idx":3},"children":["Setup Instructions:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configure webhooks to automate tracking event notifications."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide an accurate URL and credentials during setup."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure secure communication via OAuth or Basic Authentication."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"off-platform-tracking-events","__idx":4},"children":["Off-Platform Tracking Events"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"overview-1","__idx":5},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These events are for shipments processed by other platforms but tracked through Pitney Bowes. Developers must subscribe to tracking numbers to receive updates for off-platform shipments."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"setup-instructions-1","__idx":6},"children":["Setup Instructions:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Configure webhooks to automate tracking event notifications."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide an accurate URL and credentials during setup."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ensure secure communication via OAuth or Basic Authentication."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Verify that the carrier is supported by Pitney Bowes before subscribing."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide valid tracking numbers and carrier information to receive updates."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"webhook-configuration","__idx":7},"children":["Webhook Configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Developers can configure webhooks to receive tracking events as they occur. This allows real-time tracking updates for shipments associated with their account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"steps-to-configure-webhook","__idx":8},"children":["Steps to Configure Webhook:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"1-get-applicable-events","__idx":9},"children":["1. Get Applicable Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Get Applicable Event List for Webhook Configuration"]}," API to retrieve a list of trackable events."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoint"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/events"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Security"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bearerAuth"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]},": A list of event IDs and names, such as:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Manifest"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Acceptance"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["InTransit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAttempt"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OutForDelivery"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Exception"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReturnToSender"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ReadyForPickup"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PickupMissed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PickedUp"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Request:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -i -X GET \\\n  https://api-sandbox.sendpro360.pitneybowes.com/webhook/api/v1/events \\\n  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n    {\n        \"eventId\": \"Manifest\",\n        \"name\": \"Manifest\"\n    },\n    {\n        \"eventId\": \"Acceptance\",\n        \"name\": \"Acceptance\"\n    },\n    {\n        \"eventId\": \"InTransit\",\n        \"name\": \"InTransit\"\n    },\n    {\n        \"eventId\": \"DeliveryAttempt\",\n        \"name\": \"DeliveryAttempt\"\n    },\n    {\n        \"eventId\": \"OutForDelivery\",\n        \"name\": \"OutForDelivery\"\n    },\n    {\n        \"eventId\": \"Delivered\",\n        \"name\": \"Delivered\"\n    },\n    {\n        \"eventId\": \"Exception\",\n        \"name\": \"Exception\"\n    },\n    {\n        \"eventId\": \"ReturnToSender\",\n        \"name\": \"ReturnToSender\"\n    },\n    {\n        \"eventId\": \"ReadyForPickup\",\n        \"name\": \"ReadyForPickup\"\n    },\n    {\n        \"eventId\": \"PickupMissed\",\n        \"name\": \"PickupMissed\"\n    },\n    {\n        \"eventId\": \"PickedUp\",\n        \"name\": \"PickedUp\"\n    }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"2-create-webhook-configuration","__idx":10},"children":["2. Create Webhook Configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Create Webhook Configuration"]}," API to set up a webhook. Provide the events, URL, and authentication details."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Fields:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["name"]},": The name of the webhook."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["type"]},": Must be set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tracking"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["events"]},": Array of event IDs to track."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["url"]},": The webhook URL where tracking events will be sent."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["authParams"]},": Authentication details:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom"]},": Pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["apiKey"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["headerName"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Basic"]},": Pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["secret"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["OAuth"]},": pass ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["secret"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenUrl"]},"."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["tokenUrl"]},":\tOAuth token endpoint where the PitneyBowes can request access tokens."]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional Fields:"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["timeout"]},": Timeout duration in seconds for webhook responses."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["status"]},": Defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active"]},". Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["inactive"]}," to deactivate."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoint:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/webhookConfig"]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Returns a unique ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["webHookConfigID"]}," for updating webhook details."]}]}]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"authType custom","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl -i -X POST \\\n    https://api-sandbox.sendpro360.pitneybowes.com/webhook/api/v1/webhookConfig \\\n    -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \\\n    -H 'Content-Type: application/json' \\\n    -d '{\n    \"name\": \"webhook1\",\n    \"type\": \"tracking\",\n    \"events\": [\"Manifest\", \"InTransit\", \"Delivered\"],\n    \"url\": \"https://webhook.com\",\n    \"timeOut\": 5,\n    \"status\": \"active\",\n    \"authParams\": {\n        \"authType\": \"custom\",\n        \"apiKey\": \"xxxxxxxx\",\n        \"headerName\": \"webhook1\"\n    }\n    }'\n"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"authType OAuth","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl -i -X POST \\\nhttps://api-sandbox.sendpro360.pitneybowes.com/webhook/api/v1/webhookConfig \\\n-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \\\n-H 'Content-Type: application/json' \\\n-d '{\n    \"name\": \"dev_webhook1\",\n    \"type\": \"tracking\",\n    \"events\": [\n    \"Manifest\",\n    \"InTransit\",\n    \"Delivered\"\n    ],\n    \"url\": \"https://ccf8edc3-0c38-4e3a-ae94-86849a7c8895.mock.pstmn.io/hellowebhook\",\n    \"timeOut\": 5,\n    \"status\": \"active\",\n    \"authParams\": {\n    \"authType\": \"oauth\",\n    \"clientID\": \"xxxxxxxxxxxxx\",\n        \"secret\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n        \"tokenUrl\": \"https://api.xxxxxxxxxxxx.com/auth/api/v1/token\"\n    }\n}'\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["responses"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"authType custom","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n\"webHookConfigID\": \"D6yEwX1zaZjj\",\n\"name\": \"dev_webhook1\",\n\"type\": \"tracking\",\n\"events\": [\n    \"Manifest\",\n    \"InTransit\",\n    \"Delivered\"\n],\n\"url\": \"https://webhook.com\",\n\"authParams\": {\n    \"authType\": \"custom\",\n    \"apiKey\": \"xxxxxxxx\",\n    \"headerName\": \"webhook1\"\n},\n\"timeOut\": 5,\n\"status\": \"active\",\n\"developerPartnerId\": \"sacxxxx\"\n}\n"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"authType OAuth","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n\"webHookConfigID\": \"KPe5Rx44nyb6\",\n\"name\": \"dev_webhook1\",\n\"type\": \"tracking\",\n\"events\": [\n    \"Manifest\",\n    \"InTransit\",\n    \"Delivered\"\n],\n\"url\": \"https://ccf8edc3-xxxx-xxxx-xxxx-86849a7c8895.mock.pstmn.io/hellowebhook\",\n\"authParams\": {\n    \"authType\": \"oauth\",\n    \"clientID\": \"xxxxxxxxxxxxx\",\n    \"secret\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"tokenUrl\": \"https://api.xxxxxxxxxxxx.com/auth/api/v1/token\"\n},\n\"timeOut\": 5,\n\"status\": \"active\",\n\"developerPartnerId\": \"sacd0e7\"\n}\n"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"internal-oauth-flow","__idx":11},"children":["Internal OAuth Flow:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the webhook is registered with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["authType: oauth"]},", Pitney Bowes internally handles authentication as follows:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Token Request"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pitney Bowes makes a POST request to the provided ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tokenUrl"]},", using your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientID"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["secret"]}," to obtain an access token."]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":2},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Expected OAuth Response"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After receiving the POST request sent by Pitney Bowes, The token server should respond with the similar response with access token below:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n\"access_token\": \"<access-token>\",\n\"tokenType\": \"BearerToken\",\n\"issuedAt\": \"1735802883000\",\n\"expiresIn\": \"28800\",\n\"clientID\": \"xxxxxxxxxxxxx\",\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access-token"]}," is valid for the period specified in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["expiresIn"]}," response field. Token is refreshed automatically when expired."]}]},{"$$mdtype":"Tag","name":"ol","attributes":{"start":3},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Webhook Delivery"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pitney Bowes includes the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["access-token"]}," in the Authorization header when sending webhook events:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"  Authorization: Bearer <access_token>\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"3-receive-tracking-events","__idx":12},"children":["3. Receive Tracking Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once the webhook is set up, Pitney Bowes sends tracking events to your configured URL as they occur."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Expected Behavior:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorization:"]}," Webhooks use OAuth or Basic Authentication for secure communication."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response Acknowledgment:"]}," Acknowledge POST requests by returning the X-PB-developerPartnerId in the response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Retries:"]}," If Pitney Bowes does not receive a 2XX status code, it retries the request at intervals up to 16 hours."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"off-platform-tracking-events-1","__idx":13},"children":["Off-Platform Tracking Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Off-Platform shipments"]},", tracking details must be subscribed to using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Subscribe Tracking Details API"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Carrier Support:"]}," Tracking is available only if Pitney Bowes supports the specified carrier service."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unsubscribe event:"]}," To stop receiving updates for a tracking number, use the same API with subscribe set to false."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"steps-to-subscribe-tracking-details","__idx":14},"children":["Steps to Subscribe Tracking Details:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"1-subscribe-to-tracking-details","__idx":15},"children":["1. Subscribe to Tracking Details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subscribe Tracking Details"]}," API to request tracking updates for an off-platform shipment."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required Fields"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["trackingNumber"]},": The shipment's tracking number."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["carrier"]},": The carrier's ID (e.g., USPS, UPS, FedEx)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["subscribe"]},": Set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," to enable tracking updates."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoint"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v1/track/{trackingNumber}/subscribe"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Security"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bearerAuth"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Request"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -i -X GET \\\n  'https://api-sandbox.sendpro360.pitneybowes.com/shippingtracking/api/v1/track/{trackingNumber}/subscribe?carrier=USPS&subscribe=true' \\\n  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \\\n  -H 'X-PB-Developer-Partner-ID: string'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Response"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n    \"message\": \"Tracking number subscribed successfully\",\n    \"trackingEvents\": {\n      \"carrier\": \"FEDEX\",\n      \"currentLocation\": {\n        \"city\": \"Miami\",\n        \"country\": \"US\",\n        \"description\": \"Delivered\",\n        \"postalCode\": \"33122\",\n        \"stateOrProvince\": \"FL\"\n      },\n      \"currentStatus\": {\n        \"carrierEventCode\": \"DL\",\n        \"carrierEventDescription\": \"Delivered\",\n        \"eventCode\": \"AWP- Awaiting Pickup\",\n        \"eventDate\": \"2023-06-28T16:55:00.000Z\",\n        \"eventDescription\": \"Delivered\",\n        \"eventLocation\": {\n          \"city\": \"Miami\",\n          \"country\": \"US\",\n          \"description\": \"\",\n          \"postalCode\": \"33122\",\n          \"stateOrProvince\": \"FL\"\n        },\n        \"status\": \"Delivered\"\n      },\n      \"deliveryDate\": \"2023-06-28T16:55:00.000Z\",\n      \"deliveryProofUrl\": \"\",\n      \"estimatedDeliveryDate\": \"1901-01-01T00:00:00.000Z\",\n      \"serviceCode\": \"\",\n      \"serviceName\": \"FedEx Ground\",\n      \"shipDate\": \"1901-01-01T00:00:00.000Z\",\n      \"trackingHistory\": [\n        {\n          \"carrierEventCode\": \"DL\",\n          \"carrierEventDescription\": \"Delivered\",\n          \"eventCode\": \"DLD\",\n          \"eventDate\": \"2023-06-28T16:55:00.000Z\",\n          \"eventDescription\": \"Delivered\",\n          \"eventLocation\": {\n            \"city\": \"Miami\",\n            \"country\": \"US\",\n            \"description\": \"\",\n            \"postalCode\": \"33122\",\n            \"stateOrProvince\": \"FL\"\n          },\n          \"status\": \"Delivered\"\n        }\n      ]\n    }\n  }\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"2receive-tracking-details","__idx":16},"children":["2.\tReceive Tracking Details"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once subscribed, Pitney Bowes broadcasts tracking information for the off-platform shipment, such as the current status, estimated delivery date, and event history."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"End-to-End Webhook Setup","id":"end-to-end-webhook-setup","depth":1},{"value":"On-Platform Tracking Events","id":"on-platform-tracking-events","depth":2},{"value":"Overview","id":"overview","depth":3},{"value":"Setup Instructions:","id":"setup-instructions","depth":3},{"value":"Off-Platform Tracking Events","id":"off-platform-tracking-events","depth":2},{"value":"Overview","id":"overview-1","depth":3},{"value":"Setup Instructions:","id":"setup-instructions-1","depth":3},{"value":"Webhook Configuration","id":"webhook-configuration","depth":2},{"value":"Steps to Configure Webhook:","id":"steps-to-configure-webhook","depth":3},{"value":"1. Get Applicable Events","id":"1-get-applicable-events","depth":4},{"value":"2. Create Webhook Configuration","id":"2-create-webhook-configuration","depth":4},{"value":"Internal OAuth Flow:","id":"internal-oauth-flow","depth":4},{"value":"3. Receive Tracking Events","id":"3-receive-tracking-events","depth":4},{"value":"Off-Platform Tracking Events","id":"off-platform-tracking-events-1","depth":2},{"value":"Steps to Subscribe Tracking Details:","id":"steps-to-subscribe-tracking-details","depth":3},{"value":"1. Subscribe to Tracking Details","id":"1-subscribe-to-tracking-details","depth":4},{"value":"2.\tReceive Tracking Details","id":"2receive-tracking-details","depth":4}],"frontmatter":{"title":"Webhook Tracking Services","seo":{"title":"End-to-End Webhook Setup"}},"lastModified":"2026-06-24T09:51:54.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/webhook/webhook-setup-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}