[{"data":1,"prerenderedAt":876},["ShallowReactive",2],{"docs-page-\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fpush-api":3,"nav-docs_en-api_en":194,"surround-\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fpush-api":873},{"document":4,"collection":192,"isFallback":193,"defaultLocalePath":175},{"id":5,"title":6,"audience":7,"body":8,"boost":165,"date":165,"description":166,"extension":167,"keywords":168,"meta":173,"navigation":174,"path":175,"question_examples":176,"related":180,"seo":182,"slug":165,"stem":183,"summary":184,"synonyms":185,"__hash__":191},"docs_en\u002Fen\u002F2.api\u002F3.webhooks\u002F1.guides\u002F3.push-api.md","Using webhooks as a push API","api",{"type":9,"value":10,"toc":157},"minimark",[11,21,26,29,48,56,60,63,118,125,129,137,147],[12,13,14,15,20],"p",{},"The Safecube Webhooks API serves two purposes: notifying your users about specific changes in the tracking data, and updating your data automatically without any Container Tracking API request. Used the second way, it is a push container tracking API. The ",[16,17,19],"a",{"href":18},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fsync-vs-async","Synchronous and asynchronous tracking"," page compares both approaches.",[22,23,25],"h2",{"id":24},"steps-of-a-push-integration","Steps of a push integration",[12,27,28],{},"Using the Webhooks API as a push API takes five steps:",[30,31,32,36,39,42,45],"ol",{},[33,34,35],"li",{},"Set up how you want to receive the data: create an endpoint.",[33,37,38],{},"Push the shipment details to the Safecube monitoring system: add shipments to the endpoint.",[33,40,41],{},"Receive the initial tracking data of each shipment.",[33,43,44],{},"Receive an update whenever Safecube has new data for a shipment.",[33,46,47],{},"Optionally, receive an alert when a shipment you pushed cannot be tracked.",[12,49,50,51,55],{},"The ",[16,52,54],{"href":53},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fgetting-started","Getting started with webhooks"," page shows how to create an endpoint and push your first shipments.",[22,57,59],{"id":58},"recommended-events-for-push-tracking","Recommended events for push tracking",[12,61,62],{},"Subscribe the endpoint to these events:",[64,65,66,79],"table",{},[67,68,69],"thead",{},[70,71,72,76],"tr",{},[73,74,75],"th",{},"Need",[73,77,78],{},"Event",[80,81,82,94,104],"tbody",{},[70,83,84,88],{},[85,86,87],"td",{},"Receive the initial tracking data of a shipment",[85,89,90],{},[91,92,93],"code",{},"shipment.added.to.endpoint",[70,95,96,99],{},[85,97,98],{},"Receive an update whenever new data is available",[85,100,101],{},[91,102,103],{},"shipment.any.change",[70,105,106,109],{},[85,107,108],{},"Be alerted when a pushed shipment cannot be tracked",[85,110,111,114,115],{},[91,112,113],{},"shipment.in.error"," and ",[91,116,117],{},"shipment.auto.removed",[12,119,50,120,124],{},[16,121,123],{"href":122},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fevents","Webhook events"," page describes the trigger and payload of each event.",[22,126,128],{"id":127},"targeted-events-alongside-push-tracking","Targeted events alongside push tracking",[12,130,131,132,136],{},"Using the Webhooks API as a push API does not prevent more targeted notifications. Subscribing to granular events tells you at once ",[133,134,135],"strong",{},"what"," changed, from the event type itself.",[12,138,139,140,143,144,146],{},"For example, ",[91,141,142],{},"date.changed.vessel.arrival.at.final.pod"," notifies every change of the estimated time of arrival at the POD, while ",[91,145,103],{}," keeps you informed of every other update.",[148,149,151],"callout",{"type":150},"warning",[12,152,153,154,156],{},"An endpoint subscribed to both ",[91,155,103],{}," and targeted events can receive several webhooks for the same data update.",{"title":158,"searchDepth":159,"depth":159,"links":160},"",3,[161,163,164],{"id":24,"depth":162,"text":25},2,{"id":58,"depth":162,"text":59},{"id":127,"depth":162,"text":128},null,"The Safecube Webhooks API serves two purposes: notifying your users about specific changes in the tracking data, and updating your data automatically without any Container Tracking API request. Used the second way, it is a push container tracking API. The Synchronous and asynchronous tracking page compares both approaches.","md",[169,170,93,103,113,117,171,172],"push api","webhooks","automatic updates","recommended events",{},true,"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fpush-api",[177,178,179],"Can I keep my tracking data up to date with webhooks only, without calling the Container Tracking API?","Which webhook events should I subscribe to for automatic shipment data updates?","Why do I receive several webhooks for the same tracking update?",[53,122,18,181],"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fadding-shipments",{"title":6,"description":166},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F3.push-api","The Safecube Webhooks API can replace Container Tracking API requests entirely — subscribe an endpoint to shipment.added.to.endpoint, shipment.any.change, shipment.in.error and shipment.auto.removed to receive the initial tracking data, every update and every tracking failure.",[186,187,188,189,190],"push tracking","data sync","automatic data update","webhook data feed","event subscription","bZ5n4bO5xEOBn0mlfcUq5m5AVTrNl8T0V3Idgv2pR3o","docs_en",false,{"platform":195,"api":370,"faq":725,"changelog":751},[196,218,247,268,285,298,327,344,357],{"title":197,"path":198,"stem":199,"children":200,"page":193},"Getting Started","\u002Fen\u002Fplatform\u002Fgetting-started","en\u002F1.platform\u002F1.getting-started",[201,206,210,214],{"title":202,"path":203,"stem":204,"audience":205},"Creating an account","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fcreating-an-account","en\u002F1.platform\u002F1.getting-started\u002F1.creating-an-account","platform",{"title":207,"path":208,"stem":209,"audience":205},"Adding shipments","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fadding-shipments","en\u002F1.platform\u002F1.getting-started\u002F2.adding-shipments",{"title":211,"path":212,"stem":213,"audience":205},"Supported sealines","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fsupported-sealines","en\u002F1.platform\u002F1.getting-started\u002F3.supported-sealines",{"title":215,"path":216,"stem":217,"audience":205},"Navigating the platform","\u002Fen\u002Fplatform\u002Fgetting-started\u002Fnavigating-the-platform","en\u002F1.platform\u002F1.getting-started\u002F4.navigating-the-platform",{"title":219,"path":220,"stem":221,"children":222,"page":193},"Container Tracking","\u002Fen\u002Fplatform\u002Fcontainer-tracking","en\u002F1.platform\u002F2.container-tracking",[223,227,231,235,239,243],{"title":224,"path":225,"stem":226,"audience":205},"Shipment details","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-details","en\u002F1.platform\u002F2.container-tracking\u002F1.shipment-details",{"title":228,"path":229,"stem":230,"audience":205},"Shipping statuses","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipping-statuses","en\u002F1.platform\u002F2.container-tracking\u002F2.shipping-statuses",{"title":232,"path":233,"stem":234,"audience":205},"Update frequency","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fupdate-frequency","en\u002F1.platform\u002F2.container-tracking\u002F3.update-frequency",{"title":236,"path":237,"stem":238,"audience":205},"Tracking issues","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Ftracking-issues","en\u002F1.platform\u002F2.container-tracking\u002F4.tracking-issues",{"title":240,"path":241,"stem":242,"audience":205},"Sharing and export","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fsharing-and-export","en\u002F1.platform\u002F2.container-tracking\u002F5.sharing-and-export",{"title":244,"path":245,"stem":246,"audience":205},"Shipment archiving","\u002Fen\u002Fplatform\u002Fcontainer-tracking\u002Fshipment-archiving","en\u002F1.platform\u002F2.container-tracking\u002F6.shipment-archiving",{"title":248,"path":249,"stem":250,"children":251,"page":193},"Shipment Views","\u002Fen\u002Fplatform\u002Fshipment-views","en\u002F1.platform\u002F3.shipment-views",[252,256,260,264],{"title":253,"path":254,"stem":255,"audience":205},"Shipment list","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list","en\u002F1.platform\u002F3.shipment-views\u002F1.shipment-list",{"title":257,"path":258,"stem":259,"audience":205},"Shipment list columns","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fshipment-list-columns","en\u002F1.platform\u002F3.shipment-views\u002F2.shipment-list-columns",{"title":261,"path":262,"stem":263,"audience":205},"Kanban","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fkanban","en\u002F1.platform\u002F3.shipment-views\u002F3.kanban",{"title":265,"path":266,"stem":267,"audience":205},"Calendar","\u002Fen\u002Fplatform\u002Fshipment-views\u002Fcalendar","en\u002F1.platform\u002F3.shipment-views\u002F4.calendar",{"title":269,"path":270,"stem":271,"children":272,"page":193},"Alerts","\u002Fen\u002Fplatform\u002Falerts","en\u002F1.platform\u002F4.alerts",[273,277,281],{"title":274,"path":275,"stem":276,"audience":205},"Alerts page","\u002Fen\u002Fplatform\u002Falerts\u002Falerts-page","en\u002F1.platform\u002F4.alerts\u002F1.alerts-page",{"title":278,"path":279,"stem":280,"audience":205},"Alert management","\u002Fen\u002Fplatform\u002Falerts\u002Falert-management","en\u002F1.platform\u002F4.alerts\u002F2.alert-management",{"title":282,"path":283,"stem":284,"audience":205},"Notifications and reports","\u002Fen\u002Fplatform\u002Falerts\u002Fnotifications-and-reports","en\u002F1.platform\u002F4.alerts\u002F3.notifications-and-reports",{"title":286,"path":287,"stem":288,"children":289,"page":193},"Analytics","\u002Fen\u002Fplatform\u002Fanalytics","en\u002F1.platform\u002F5.analytics",[290,294],{"title":291,"path":292,"stem":293,"audience":205},"Performance analytics","\u002Fen\u002Fplatform\u002Fanalytics\u002Fperformance","en\u002F1.platform\u002F5.analytics\u002F1.performance",{"title":295,"path":296,"stem":297,"audience":205},"Sustainability","\u002Fen\u002Fplatform\u002Fanalytics\u002Fsustainability","en\u002F1.platform\u002F5.analytics\u002F2.sustainability",{"title":299,"path":300,"stem":301,"children":302,"page":193},"Workspace","\u002Fen\u002Fplatform\u002Fworkspace","en\u002F1.platform\u002F6.workspace",[303,307,311,315,319,323],{"title":304,"path":305,"stem":306,"audience":205},"Users and roles","\u002Fen\u002Fplatform\u002Fworkspace\u002Fusers-and-roles","en\u002F1.platform\u002F6.workspace\u002F1.users-and-roles",{"title":308,"path":309,"stem":310,"audience":205},"Teams","\u002Fen\u002Fplatform\u002Fworkspace\u002Fteams","en\u002F1.platform\u002F6.workspace\u002F2.teams",{"title":312,"path":313,"stem":314,"audience":205},"Documents","\u002Fen\u002Fplatform\u002Fworkspace\u002Fdocuments","en\u002F1.platform\u002F6.workspace\u002F3.documents",{"title":316,"path":317,"stem":318,"audience":205},"Workspace settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Fworkspace-settings","en\u002F1.platform\u002F6.workspace\u002F4.workspace-settings",{"title":320,"path":321,"stem":322,"audience":205},"White label","\u002Fen\u002Fplatform\u002Fworkspace\u002Fwhite-label","en\u002F1.platform\u002F6.workspace\u002F5.white-label",{"title":324,"path":325,"stem":326,"audience":205},"Account settings","\u002Fen\u002Fplatform\u002Fworkspace\u002Faccount-settings","en\u002F1.platform\u002F6.workspace\u002F6.account-settings",{"title":328,"path":329,"stem":330,"children":331,"page":193},"Billing","\u002Fen\u002Fplatform\u002Fbilling","en\u002F1.platform\u002F7.billing",[332,336,340],{"title":333,"path":334,"stem":335,"audience":205},"Billing and payment","\u002Fen\u002Fplatform\u002Fbilling\u002Fbilling-and-payment","en\u002F1.platform\u002F7.billing\u002F1.billing-and-payment",{"title":337,"path":338,"stem":339,"audience":205},"Shipment billing","\u002Fen\u002Fplatform\u002Fbilling\u002Fshipment-billing","en\u002F1.platform\u002F7.billing\u002F2.shipment-billing",{"title":341,"path":342,"stem":343,"audience":205},"Free trial","\u002Fen\u002Fplatform\u002Fbilling\u002Ffree-trial","en\u002F1.platform\u002F7.billing\u002F3.free-trial",{"title":345,"path":346,"stem":347,"children":348,"page":193},"Developers","\u002Fen\u002Fplatform\u002Fdevelopers","en\u002F1.platform\u002F8.developers",[349,353],{"title":350,"path":351,"stem":352,"audience":205},"API credentials","\u002Fen\u002Fplatform\u002Fdevelopers\u002Fapi-credentials","en\u002F1.platform\u002F8.developers\u002F1.api-credentials",{"title":354,"path":355,"stem":356,"audience":205},"Webhooks console","\u002Fen\u002Fplatform\u002Fdevelopers\u002Fwebhooks-console","en\u002F1.platform\u002F8.developers\u002F2.webhooks-console",{"title":358,"path":359,"stem":360,"children":361,"page":193},"Integrations","\u002Fen\u002Fplatform\u002Fintegrations","en\u002F1.platform\u002F9.integrations",[362,366],{"title":363,"path":364,"stem":365,"audience":205},"Salesforce installation","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-installation","en\u002F1.platform\u002F9.integrations\u002F1.salesforce-installation",{"title":367,"path":368,"stem":369,"audience":205},"Salesforce user guide","\u002Fen\u002Fplatform\u002Fintegrations\u002Fsalesforce-user-guide","en\u002F1.platform\u002F9.integrations\u002F2.salesforce-user-guide",[371,387,459,617,652,684],{"title":197,"path":372,"stem":373,"children":374,"page":193},"\u002Fen\u002Fapi\u002Fgetting-started","en\u002F2.api\u002F1.getting-started",[375,379,383],{"title":376,"path":377,"stem":378,"audience":7},"API overview","\u002Fen\u002Fapi\u002Fgetting-started\u002Foverview","en\u002F2.api\u002F1.getting-started\u002F1.overview",{"title":380,"path":381,"stem":382,"audience":7},"Authentication","\u002Fen\u002Fapi\u002Fgetting-started\u002Fauthentication","en\u002F2.api\u002F1.getting-started\u002F2.authentication",{"title":384,"path":385,"stem":386,"audience":7},"Rate limits","\u002Fen\u002Fapi\u002Fgetting-started\u002Frate-limits","en\u002F2.api\u002F1.getting-started\u002F3.rate-limits",{"title":219,"path":388,"stem":389,"children":390,"page":193},"\u002Fen\u002Fapi\u002Fcontainer-tracking","en\u002F2.api\u002F2.container-tracking",[391,428],{"title":392,"path":393,"stem":394,"children":395,"page":193},"Guides","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides","en\u002F2.api\u002F2.container-tracking\u002F1.guides",[396,400,404,408,412,416,420,424],{"title":397,"path":398,"stem":399,"audience":7},"Getting started with the Container Tracking API","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F1.getting-started",{"title":401,"path":402,"stem":403,"audience":7},"Shipment location","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-location","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F2.shipment-location",{"title":405,"path":406,"stem":407,"audience":7},"Shipment route","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fshipment-route","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F3.shipment-route",{"title":409,"path":410,"stem":411,"audience":7},"Demurrage risk","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fdemurrage-risk","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F4.demurrage-risk",{"title":413,"path":414,"stem":415,"audience":7},"Error codes","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Ferror-codes","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F5.error-codes",{"title":417,"path":418,"stem":419,"audience":7},"Status and event codes","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fstatus-and-event-codes","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F6.status-and-event-codes",{"title":421,"path":422,"stem":423,"audience":7},"Supported shipping lines","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsupported-sealines","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F7.supported-sealines",{"title":425,"path":426,"stem":427,"audience":7},"Sandbox and test shipments","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Fguides\u002Fsandbox","en\u002F2.api\u002F2.container-tracking\u002F1.guides\u002F8.sandbox",{"title":429,"path":430,"stem":431,"children":432,"page":193},"Reference","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference","en\u002F2.api\u002F2.container-tracking\u002F2.reference",[433,439,444,449,454],{"title":434,"path":435,"stem":436,"method":437,"endpoint":438},"Retrieve shipment tracking data","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-shipment-detail","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F1.get-shipment-detail","GET","\u002Fshipment",{"title":440,"path":441,"stem":442,"method":437,"endpoint":443},"Retrieve shipment tracking data in a Searates-compatible format","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-shipment-searates-format","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F2.get-shipment-searates-format","\u002Fshipment-format\u002Fsearates",{"title":445,"path":446,"stem":447,"method":437,"endpoint":448},"Retrieve available sealines","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fget-sea-line-details","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F3.get-sea-line-details","\u002Fsealines",{"title":450,"path":451,"stem":452,"method":437,"endpoint":453},"Retrieve your monthly usages","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fretrieve-usages","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F4.retrieve-usages","\u002Fusages",{"title":455,"path":456,"stem":457,"method":437,"endpoint":458},"Retrieve list of shipments called with the API, that usages have a minimum resolution of a month (you cant select the usage for one  week for example, the usage will automatically be for the month of the week provided)","\u002Fen\u002Fapi\u002Fcontainer-tracking\u002Freference\u002Fretrieve-shipment-usages","en\u002F2.api\u002F2.container-tracking\u002F2.reference\u002F5.retrieve-shipment-usages","\u002Fshipment-usage",{"title":460,"path":461,"stem":462,"children":463,"page":193},"Webhooks","\u002Fen\u002Fapi\u002Fwebhooks","en\u002F2.api\u002F3.webhooks",[464,493],{"title":392,"path":465,"stem":466,"children":467,"page":193},"\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides","en\u002F2.api\u002F3.webhooks\u002F1.guides",[468,470,472,473,475,479,483,487,489],{"title":54,"path":53,"stem":469,"audience":7},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F1.getting-started",{"title":19,"path":18,"stem":471,"audience":7},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F2.sync-vs-async",{"title":6,"path":175,"stem":183,"audience":7},{"title":207,"path":181,"stem":474,"audience":7},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F4.adding-shipments",{"title":476,"path":477,"stem":478,"audience":7},"Testing your webhook endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ftesting-your-endpoint","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F5.testing-your-endpoint",{"title":480,"path":481,"stem":482,"audience":7},"Detecting and recovering webhook failures","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Ffailure-recovery","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F6.failure-recovery",{"title":484,"path":485,"stem":486,"audience":7},"Shipment usage","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fshipment-usage","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F7.shipment-usage",{"title":123,"path":122,"stem":488,"audience":7},"en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F8.events",{"title":490,"path":491,"stem":492,"audience":7},"Auto-removal policy","\u002Fen\u002Fapi\u002Fwebhooks\u002Fguides\u002Fauto-removal-policy","en\u002F2.api\u002F3.webhooks\u002F1.guides\u002F9.auto-removal-policy",{"title":429,"path":494,"stem":495,"children":496,"page":193},"\u002Fen\u002Fapi\u002Fwebhooks\u002Freference","en\u002F2.api\u002F3.webhooks\u002F2.reference",[497,575,598,608],{"title":498,"path":499,"stem":500,"children":501,"page":193},"Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints",[502,508,512,517,522,527,532,537,542,547,552,557,562,566,570],{"title":503,"path":504,"stem":505,"method":506,"endpoint":507},"Create Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-create","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F1.endpoint-create","POST","\u002Fendpoint",{"title":509,"path":510,"stem":511,"method":437,"endpoint":507},"List Endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-list","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F2.endpoint-list",{"title":513,"path":514,"stem":515,"method":437,"endpoint":516},"Get Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F3.endpoint-get","\u002Fendpoint\u002F{endpoint_id}",{"title":518,"path":519,"stem":520,"method":521,"endpoint":516},"Update Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-update","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F4.endpoint-update","PUT",{"title":523,"path":524,"stem":525,"method":526,"endpoint":516},"Delete Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-delete","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F5.endpoint-delete","DELETE",{"title":528,"path":529,"stem":530,"method":531,"endpoint":516},"Patch Endpoint","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-patch","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F6.endpoint-patch","PATCH",{"title":533,"path":534,"stem":535,"method":437,"endpoint":536},"Get Endpoint Secret","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get-secret","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F7.endpoint-get-secret","\u002Fendpoint\u002F{endpoint_id}\u002Fsecret",{"title":538,"path":539,"stem":540,"method":506,"endpoint":541},"Rotate Endpoint Secret","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-rotate-secret","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F8.endpoint-rotate-secret","\u002Fendpoint\u002F{endpoint_id}\u002Fsecret\u002Frotate",{"title":543,"path":544,"stem":545,"method":437,"endpoint":546},"Endpoint Stats","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get-stats","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F9.endpoint-get-stats","\u002Fendpoint\u002F{endpoint_id}\u002Fstats",{"title":548,"path":549,"stem":550,"method":506,"endpoint":551},"Recover Failed Webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-recover","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F10.endpoint-recover","\u002Fendpoint\u002F{endpoint_id}\u002Frecover",{"title":553,"path":554,"stem":555,"method":506,"endpoint":556},"Replay Missing Webhooks","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-replay","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F11.endpoint-replay","\u002Fendpoint\u002F{endpoint_id}\u002Freplay-missing",{"title":558,"path":559,"stem":560,"method":437,"endpoint":561},"Get Endpoint Headers","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-get-headers","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F12.endpoint-get-headers","\u002Fendpoint\u002F{endpoint_id}\u002Fheaders",{"title":563,"path":564,"stem":565,"method":521,"endpoint":561},"Update Endpoint Headers","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-update-headers","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F13.endpoint-update-headers",{"title":567,"path":568,"stem":569,"method":531,"endpoint":561},"Patch Endpoint Headers","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-patch-headers","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F14.endpoint-patch-headers",{"title":571,"path":572,"stem":573,"method":506,"endpoint":574},"Send Event Type Example Message","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fendpoints\u002Fendpoint-send-example","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F1.endpoints\u002F15.endpoint-send-example","\u002Fendpoint\u002F{endpoint_id}\u002Fsend-example",{"title":576,"path":577,"stem":578,"children":579,"page":193},"Easy Shipment","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment",[580,585,590,594],{"title":581,"path":582,"stem":583,"method":506,"endpoint":584},"Add shipments asynchronously","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-add-async","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F1.easy-shipment-add-async","\u002Feasy-shipment-asynchronous",{"title":586,"path":587,"stem":588,"method":437,"endpoint":589},"Get the list of shipments for all your endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-get","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F2.easy-shipment-get","\u002Feasy-shipment",{"title":591,"path":592,"stem":593,"method":521,"endpoint":589},"Update shipments to endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-update","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F3.easy-shipment-update",{"title":595,"path":596,"stem":597,"method":526,"endpoint":589},"Delete shipments to endpoints","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Feasy-shipment\u002Feasy-shipment-delete","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F2.easy-shipment\u002F4.easy-shipment-delete",{"title":599,"path":600,"stem":601,"children":602,"page":193},"Application","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application",[603],{"title":604,"path":605,"stem":606,"method":437,"endpoint":607},"Get dashboard url","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fapplication\u002Fapplication-dashboard","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F3.application\u002F1.application-dashboard","\u002Fdashboard",{"title":609,"path":610,"stem":611,"children":612,"page":193},"Usages","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fusages","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F4.usages",[613],{"title":614,"path":615,"stem":616,"method":437,"endpoint":458},"Retrieve list of shipments called with the API","\u002Fen\u002Fapi\u002Fwebhooks\u002Freference\u002Fusages\u002Fretrieve-shipment-usages","en\u002F2.api\u002F3.webhooks\u002F2.reference\u002F4.usages\u002F1.retrieve-shipment-usages",{"title":618,"path":619,"stem":620,"children":621,"page":193},"Shipment Management","\u002Fen\u002Fapi\u002Fshipment-management","en\u002F2.api\u002F4.shipment-management",[622,634],{"title":392,"path":623,"stem":624,"children":625,"page":193},"\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides","en\u002F2.api\u002F4.shipment-management\u002F1.guides",[626,630],{"title":627,"path":628,"stem":629,"audience":7},"Getting started with the Shipment Management API","\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F1.getting-started",{"title":631,"path":632,"stem":633,"audience":7},"Embed a shipment in an iframe","\u002Fen\u002Fapi\u002Fshipment-management\u002Fguides\u002Fiframe-embed","en\u002F2.api\u002F4.shipment-management\u002F1.guides\u002F2.iframe-embed",{"title":429,"path":635,"stem":636,"children":637,"page":193},"\u002Fen\u002Fapi\u002Fshipment-management\u002Freference","en\u002F2.api\u002F4.shipment-management\u002F2.reference",[638,643,647],{"title":639,"path":640,"stem":641,"method":506,"endpoint":642},"Create shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fcreate-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F1.create-shipments","\u002Fpublic\u002Fshipments",{"title":644,"path":645,"stem":646,"method":526,"endpoint":642},"Delete multiple shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fdelete-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F2.delete-shipments",{"title":648,"path":649,"stem":650,"method":506,"endpoint":651},"Get multiple shipments","\u002Fen\u002Fapi\u002Fshipment-management\u002Freference\u002Fsearch-shipments","en\u002F2.api\u002F4.shipment-management\u002F2.reference\u002F3.search-shipments","\u002Fpublic\u002Fshipments\u002Fsearch",{"title":653,"path":654,"stem":655,"children":656,"page":193},"Ports Intelligence","\u002Fen\u002Fapi\u002Fports-intelligence","en\u002F2.api\u002F5.ports-intelligence",[657,665],{"title":392,"path":658,"stem":659,"children":660,"page":193},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides",[661],{"title":662,"path":663,"stem":664,"audience":7},"Port occupation","\u002Fen\u002Fapi\u002Fports-intelligence\u002Fguides\u002Fport-occupation","en\u002F2.api\u002F5.ports-intelligence\u002F1.guides\u002F1.port-occupation",{"title":429,"path":666,"stem":667,"children":668,"page":193},"\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference",[669,674,679],{"title":670,"path":671,"stem":672,"method":437,"endpoint":673},"Search Port Details by its name or unlocode","\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference\u002Fsearch-port-details","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference\u002F1.search-port-details","\u002Fports\u002Fsearch",{"title":675,"path":676,"stem":677,"method":437,"endpoint":678},"Get Port Details by unlocode","\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference\u002Fget-port-details","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference\u002F2.get-port-details","\u002Fports\u002F{unlocode}",{"title":680,"path":681,"stem":682,"method":437,"endpoint":683},"Get Vessels in port","\u002Fen\u002Fapi\u002Fports-intelligence\u002Freference\u002Fget-vessels-in-port","en\u002F2.api\u002F5.ports-intelligence\u002F2.reference\u002F3.get-vessels-in-port","\u002Fports\u002F{unlocode}\u002Fvessels-in-port",{"title":685,"path":686,"stem":687,"children":688,"page":193},"Congestion","\u002Fen\u002Fapi\u002Fcongestion","en\u002F2.api\u002F6.congestion",[689,701],{"title":392,"path":690,"stem":691,"children":692,"page":193},"\u002Fen\u002Fapi\u002Fcongestion\u002Fguides","en\u002F2.api\u002F6.congestion\u002F1.guides",[693,697],{"title":694,"path":695,"stem":696,"audience":7},"Getting started with the Congestion API","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fgetting-started","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F1.getting-started",{"title":698,"path":699,"stem":700,"audience":7},"Congestion API coverage","\u002Fen\u002Fapi\u002Fcongestion\u002Fguides\u002Fcoverage","en\u002F2.api\u002F6.congestion\u002F1.guides\u002F2.coverage",{"title":429,"path":702,"stem":703,"children":704,"page":193},"\u002Fen\u002Fapi\u002Fcongestion\u002Freference","en\u002F2.api\u002F6.congestion\u002F2.reference",[705,710,715,720],{"title":706,"path":707,"stem":708,"method":437,"endpoint":709},"Retrieve aggregated congestion data for a port","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-congestion-aggregate","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F1.retrieve-congestion-aggregate","\u002Fcongestion\u002F{portCode}",{"title":711,"path":712,"stem":713,"method":506,"endpoint":714},"Retrieve aggregated congestion data for multiple ports","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-congestion-aggregate-batch","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F2.retrieve-congestion-aggregate-batch","\u002Fcongestion\u002Fbatch",{"title":716,"path":717,"stem":718,"method":437,"endpoint":719},"Retrieve the current credit consumption period","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-current-consumption-period","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F3.retrieve-current-consumption-period","\u002Fconsumption\u002Fcurrent-period",{"title":721,"path":722,"stem":723,"method":437,"endpoint":724},"Retrieve all credit consumption periods","\u002Fen\u002Fapi\u002Fcongestion\u002Freference\u002Fretrieve-consumption-periods","en\u002F2.api\u002F6.congestion\u002F2.reference\u002F4.retrieve-consumption-periods","\u002Fconsumption\u002Fperiods",[726,731,735,739,743,747],{"title":727,"path":728,"stem":729,"audience":730},"Getting started and scope","\u002Fen\u002Ffaq\u002Fgetting-started","en\u002F3.faq\u002F1.getting-started","faq",{"title":732,"path":733,"stem":734,"audience":730},"Tracking","\u002Fen\u002Ffaq\u002Ftracking","en\u002F3.faq\u002F2.tracking",{"title":736,"path":737,"stem":738,"audience":730},"Billing and plans","\u002Fen\u002Ffaq\u002Fbilling","en\u002F3.faq\u002F3.billing",{"title":740,"path":741,"stem":742,"audience":730},"Account and workspace","\u002Fen\u002Ffaq\u002Faccount","en\u002F3.faq\u002F4.account",{"title":744,"path":745,"stem":746,"audience":730},"API and integration","\u002Fen\u002Ffaq\u002Fapi","en\u002F3.faq\u002F5.api",{"title":748,"path":749,"stem":750,"audience":730},"Security and legal","\u002Fen\u002Ffaq\u002Fsecurity-and-legal","en\u002F3.faq\u002F6.security-and-legal",[752,757,761,765,769,773,777,781,785,789,793,797,801,805,809,813,817,821,825,829,833,837,841,845,849,853,857,861,865,869],{"title":753,"path":754,"stem":755,"audience":756},"November 2026","\u002Fen\u002Fchangelog\u002F2026-11-09","en\u002F4.changelog\u002F2026-11-09","changelog",{"title":758,"path":759,"stem":760,"audience":756},"October 2026","\u002Fen\u002Fchangelog\u002F2026-10-21","en\u002F4.changelog\u002F2026-10-21",{"title":762,"path":763,"stem":764,"audience":756},"September 2026","\u002Fen\u002Fchangelog\u002F2026-09-09","en\u002F4.changelog\u002F2026-09-09",{"title":766,"path":767,"stem":768,"audience":756},"August 2026","\u002Fen\u002Fchangelog\u002F2026-08-19","en\u002F4.changelog\u002F2026-08-19",{"title":770,"path":771,"stem":772,"audience":756},"July 2026","\u002Fen\u002Fchangelog\u002F2026-07-30","en\u002F4.changelog\u002F2026-07-30",{"title":774,"path":775,"stem":776,"audience":756},"June 2026","\u002Fen\u002Fchangelog\u002F2026-06-16","en\u002F4.changelog\u002F2026-06-16",{"title":778,"path":779,"stem":780,"audience":756},"April 2026","\u002Fen\u002Fchangelog\u002F2026-04-29","en\u002F4.changelog\u002F2026-04-29",{"title":782,"path":783,"stem":784,"audience":756},"March 2026","\u002Fen\u002Fchangelog\u002F2026-03-31","en\u002F4.changelog\u002F2026-03-31",{"title":786,"path":787,"stem":788,"audience":756},"February 2026","\u002Fen\u002Fchangelog\u002F2026-02-25","en\u002F4.changelog\u002F2026-02-25",{"title":790,"path":791,"stem":792,"audience":756},"January 2026","\u002Fen\u002Fchangelog\u002F2026-01-27","en\u002F4.changelog\u002F2026-01-27",{"title":794,"path":795,"stem":796,"audience":756},"December 2025","\u002Fen\u002Fchangelog\u002F2025-12-15","en\u002F4.changelog\u002F2025-12-15",{"title":798,"path":799,"stem":800,"audience":756},"November 2025","\u002Fen\u002Fchangelog\u002F2025-11-28","en\u002F4.changelog\u002F2025-11-28",{"title":802,"path":803,"stem":804,"audience":756},"September 2025","\u002Fen\u002Fchangelog\u002F2025-09-04","en\u002F4.changelog\u002F2025-09-04",{"title":806,"path":807,"stem":808,"audience":756},"August 2025","\u002Fen\u002Fchangelog\u002F2025-08-20","en\u002F4.changelog\u002F2025-08-20",{"title":810,"path":811,"stem":812,"audience":756},"July 2025","\u002Fen\u002Fchangelog\u002F2025-07-21","en\u002F4.changelog\u002F2025-07-21",{"title":814,"path":815,"stem":816,"audience":756},"June 2025","\u002Fen\u002Fchangelog\u002F2025-06-23","en\u002F4.changelog\u002F2025-06-23",{"title":818,"path":819,"stem":820,"audience":756},"May 2025","\u002Fen\u002Fchangelog\u002F2025-05-26","en\u002F4.changelog\u002F2025-05-26",{"title":822,"path":823,"stem":824,"audience":756},"April 2025","\u002Fen\u002Fchangelog\u002F2025-04-28","en\u002F4.changelog\u002F2025-04-28",{"title":826,"path":827,"stem":828,"audience":756},"March 2025","\u002Fen\u002Fchangelog\u002F2025-03-31","en\u002F4.changelog\u002F2025-03-31",{"title":830,"path":831,"stem":832,"audience":756},"February 2025","\u002Fen\u002Fchangelog\u002F2025-02-26","en\u002F4.changelog\u002F2025-02-26",{"title":834,"path":835,"stem":836,"audience":756},"January 2025","\u002Fen\u002Fchangelog\u002F2025-01-30","en\u002F4.changelog\u002F2025-01-30",{"title":838,"path":839,"stem":840,"audience":756},"December 2024","\u002Fen\u002Fchangelog\u002F2024-12-19","en\u002F4.changelog\u002F2024-12-19",{"title":842,"path":843,"stem":844,"audience":756},"November 2024","\u002Fen\u002Fchangelog\u002F2024-11-28","en\u002F4.changelog\u002F2024-11-28",{"title":846,"path":847,"stem":848,"audience":756},"October 2024","\u002Fen\u002Fchangelog\u002F2024-10-30","en\u002F4.changelog\u002F2024-10-30",{"title":850,"path":851,"stem":852,"audience":756},"September 2024","\u002Fen\u002Fchangelog\u002F2024-09-23","en\u002F4.changelog\u002F2024-09-23",{"title":854,"path":855,"stem":856,"audience":756},"August 2024","\u002Fen\u002Fchangelog\u002F2024-08-30","en\u002F4.changelog\u002F2024-08-30",{"title":858,"path":859,"stem":860,"audience":756},"July 2024","\u002Fen\u002Fchangelog\u002F2024-07-29","en\u002F4.changelog\u002F2024-07-29",{"title":862,"path":863,"stem":864,"audience":756},"June 2024","\u002Fen\u002Fchangelog\u002F2024-06-25","en\u002F4.changelog\u002F2024-06-25",{"title":866,"path":867,"stem":868,"audience":756},"May 2024","\u002Fen\u002Fchangelog\u002F2024-05-31","en\u002F4.changelog\u002F2024-05-31",{"title":870,"path":871,"stem":872,"audience":756},"April 2024","\u002Fen\u002Fchangelog\u002F2024-04-30","en\u002F4.changelog\u002F2024-04-30",[874,875],{"title":19,"path":18,"stem":471,"children":-1},{"title":207,"path":181,"stem":474,"children":-1},1794931507043]