{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Locker Webhook Events","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":"locker-webhook-events","__idx":0},"children":["Locker Webhook Events"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When subscribed to tracking events for Locker APIs, you will receive a JSON each time there is a status update."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Below are the examples of a Webhook event :"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"locker-webhook-sqs-events-by-activity-type","__idx":1},"children":["Locker Webhook SQS events by activity type"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["1. Reservation"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"activityCode\": \"reservation\",\n  \"activityDate\": \"2026-06-08T08:09:46.00001068Z\",\n  \"contactId\": \"684a6b7bbc85e1bce73xxxxx\",\n  \"contactType\": \"recipient\",\n  \"depositorAccessCode\": \"OTACE7EDNR\",\n  \"depositorContactId\": \"6a2678b5a07ad165349xxxxx\",\n  \"depositorContactType\": \"recipient\",\n  \"lockerBankId\": \"LB-AONE-001\",\n  \"lockerUnitId\": \"12\",\n  \"photo\": {\n    \"base64\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=\",\n    \"contentType\": \"image/png\"\n  },\n  \"signature\": {\n    \"base64\": \"iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII=\",\n    \"contentType\": \"image/png\"\n  },\n  \"subId\": \"xxxxxx\",\n  \"trackingNumber\": \"1Z999AA10123456XXX\",\n  \"secondaryTrackingNumber\": \"9405511899223197428507\",\n  \"transactionType\": \"return\",\n  \"userId\": \"thridparty\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["2. Update reservation"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"activityCode\": \"updatereservation\",\n  \"activityDate\": \"2026-06-12T14:12:07Z\",\n  \"contactId\": \"684a6b7bbc85e1bce73xxxxx\",\n  \"contactType\": \"recipient\",\n  \"lockerBankId\": \"LB-AONE-001\",\n  \"lockerUnitId\": \"2\",\n  \"photo\": {},\n  \"signature\": {},\n  \"subId\": \"xxxxxx\",\n  \"trackingNumber\": \"1Z999AA10123456XXX\",\n  \"transactionType\": \"deliver\",\n  \"userId\": \"thridpartyuser@yopmail.com\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["3. Cancel Reservation"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"activityCode\": \"cancelreservation\",\n  \"activityDate\": \"2026-06-12T14:14:39.934260457Z\",\n  \"contactId\": \"684a6b7bbc85e1bce73xxxxx\",\n  \"contactType\": \"recipient\",\n  \"lockerBankId\": \"LB-AONE-001\",\n  \"lockerUnitId\": \"2\",\n  \"photo\": {},\n  \"signature\": {},\n  \"subId\": \"xxxxxx\",\n  \"trackingNumber\": \"1Z999AA10123456XXX\",\n  \"transactionType\": \"deliver\",\n  \"userId\": \"ThirdParty\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["4. Deposit"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"activityCode\": \"deposit\",\n  \"activityDate\": \"2026-06-12T14:16:07.697006627Z\",\n  \"contactId\": \"684a6b7bbc85e1bce73xxxxx\",\n  \"contactType\": \"recipient\",\n  \"lockerBankId\": \"LB-AONE-001\",\n  \"lockerUnitId\": \"2\",\n  \"photo\": {\n    \"base64\": \"/9j/4AAQSkZJRgABAQAAAQABAAD/ //AABEIAf8D6AMBIgACEQEDEQH/xAAVAAEBAAAAAAAAAAAAAAAAAAAABv/ /EABQRAQAAAAAAAAAAAAAAAAAAAAD/2gAMAwEAAhEDEQA/AIgAAAABQAAAAAAAAAAAQAFABAAUAAAAAEABQAQAAAFAAAAAAQEABQAAAQAFAAAAAAAAAAABAAUAEAAABQAQAAAFAAABAAAAAAUAAAEAAAAABQAQAAAAAAAAAFABAAAAUAEAAH/2Q==\",\n    \"contentType\": \"image/jpeg\"\n  },\n  \"signature\": {},\n  \"subId\": \"xxxxxx\",\n  \"trackingNumber\": \"1Z999AA10123456XXX\",\n  \"transactionType\": \"deliver\",\n  \"userId\": \"thirdpartyuser@gmail.com\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["5. Recipient Pickup"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"activityCode\": \"pickup\",\n  \"activityDate\": \"2026-06-11T17:24:31.564903411Z\",\n  \"contactId\": \"684a6b7bbc85e1bce73xxxxx\",\n  \"contactType\": \"recipient\",\n  \"lockerBankId\": \"LB-AONE-001\",\n  \"lockerUnitId\": \"7\",\n  \"photo\": {\n    \"base64\": \"4QDKRXhpZgAATU0AKgAAAAgABgESAAMAAAABAAEAAAEaAAUAAAABAAAAVgEbAAUAAAABAAAAXgEoAAMAAAABAAIAAAITAAMAAAABAAEAAIdpAAQAAABAAAAZgAAAAAAAABIAAAAA\",\n    \"contentType\": \"image/gif\"\n  },\n  \"signature\": {\n    \"base64\": \"4QDKRXhpZgAATU0AKgAAAAgABgESAAMAAAABAAEAAAEaAAUAAAABAAAAVgEbAAUAAAABAAAAXgEoAAMAAAABAAIAAAITAAMAAAABAAEAAIdpAAQAAABAAAAZgAAAAAAAABIAAAAA\",\n    \"contentType\": \"image/gif\"\n  },\n  \"subId\": \"xxxxxx\",\n  \"trackingNumber\": \"1Z999AA10123456XXX\",\n  \"transactionType\": \"deliver\",\n  \"userId\": \"thirdpartyuser@gmail.com\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["6. Admin Pickup"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"activityCode\": \"stalemailpickup\",\n  \"activityDate\": \"2026-06-12T14:36:35.342807875Z\",\n  \"contactId\": \"684a6b7bbc85e1bce73xxxxx\",\n  \"contactType\": \"recipient\",\n  \"lockerBankId\": \"LB-AONE-001\",\n  \"lockerUnitId\": \"2\",\n  \"photo\": {},\n  \"signature\": {},\n  \"subId\": \"xxxxxx\",\n  \"trackingNumber\": \"1Z999AA10123456XXX\",\n  \"transactionType\": \"deliver\",\n  \"userId\": \"thirdpartyuser@gmail.com\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["7. Open locker"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"activityCode\": \"openlocker\",\n  \"activityDate\": \"2026-04-12T17:08:33.85440614Z\",\n  \"contactId\": \"684a6b7bbc85e1bce739xxxx\",\n  \"contactType\": \"recipient\",\n  \"lockerBankId\": \"App1\",\n  \"lockerUnitId\": \"1\",\n  \"photo\": {},\n  \"signature\": {},\n  \"subId\": \"xxxxxxx\",\n  \"trackingNumber\": \"1Z999AA10123456XXX\",\n  \"transactionType\": \"deliver\",\n  \"userId\": \"thirdpartyuser@gmail.com\"\n}\n\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["8. Locker On Hold"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{ \n  \"activityCode\": \"onhold\", \n  \"activityDate\": \"2026-08-20T05:54:58.70827885Z\", \n  \"contactId\": \"684a6b7bbc85e1bce739xxxx\", \n  \"contactType\": \"recipient\", \n  \"lockerBankId\": \"App1\", \n  \"lockerUnitId\": \"9\", \n  \"photo\": {}, \n  \"signature\": {}, \n  \"subId\": \"xxxxxxx\", \n  \"trackingNumber\": \"553323XX\", \n  \"transactionType\": \"deliver\", \n  \"userId\": \"AdminUser@youmail.com\" \n} \n\n","lang":"json"},"children":[]}]},"headings":[{"value":"Locker Webhook Events","id":"locker-webhook-events","depth":1},{"value":"Locker Webhook SQS events by activity type","id":"locker-webhook-sqs-events-by-activity-type","depth":2}],"frontmatter":{"title":"Locker Webhook Events","seo":{"title":"Locker Webhook Events"}},"lastModified":"2026-08-25T15:15:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/webhook/lockerwebhookeventpayloads","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}