# Container tracking & Webhooks Documentation > Documentation Hub for Container Tracking API & Webhooks services from Sinay. ## Platform Documentation: Getting Started 💡 - [Welcome Aboard 🌊](https://documentation.safecube.ai/docs/getting-started.md) ## Platform Documentation: CONTAINER TRACKING - [Adding Shipments](https://documentation.safecube.ai/docs/safecube-basics.md) - [Supported Sealines](https://documentation.safecube.ai/docs/supported-sealines-1.md) - [Understanding Shipment Details](https://documentation.safecube.ai/docs/understanding-container-tracking-data.md) - [Update Frequency](https://documentation.safecube.ai/docs/update-frequency.md) - [Analytics](https://documentation.safecube.ai/docs/analytics.md) - [Automatic Shipment Archiving](https://documentation.safecube.ai/docs/automatic-shipment-archiving.md): Safecube automatically archives shipments 30 days after they reach DELIVERED status. This feature keeps your workspace organized by separating completed deliveries from active shipments, while… ## Platform Documentation: Workspace Management & Collaboration - [Users & Roles](https://documentation.safecube.ai/docs/managing-users-and-groups.md) - [Working with Groups](https://documentation.safecube.ai/docs/working-with-groups.md) - [Adding Data to Your Shipment List](https://documentation.safecube.ai/docs/customize-your-view.md): Add columns, hide them, change the order. - [Working with Tasks](https://documentation.safecube.ai/docs/working-with-tasks.md) - [Working with documents](https://documentation.safecube.ai/docs/working-with-documents.md) - [White Label](https://documentation.safecube.ai/docs/white-label.md): Customize Safecube url and Logo to your Branding. - [Alert Management](https://documentation.safecube.ai/docs/alert-priority-management.md): This page explains how to configure alerts from the Safecube platform. ## Platform Documentation: BILLING AND PAYMENTS - [Billing and Payment](https://documentation.safecube.ai/docs/billing-and-payment.md) - [Understand Shipment Billing](https://documentation.safecube.ai/docs/understand-shipment-billing.md) ## Platform Documentation: INTEGRATIONS - Salesforce - [Installation Guide](https://documentation.safecube.ai/docs/safecube-salesforce-package-installation-guide.md): This document provides step-by-step instructions to install and configure the Safecube package in your Salesforce environment. - [User guide](https://documentation.safecube.ai/docs/safecube-salesforce-application.md): Short user guide for the Safecube app in Salesforce. - [Excel](https://documentation.safecube.ai/docs/excel.md): Export container tracking data to CSV for seamless Excel and BI tool integration. - [API ](https://documentation.safecube.ai/docs/api.md) ## API Endpoints: INTRODUCTION - [Mandatory Headers](https://documentation.safecube.ai/reference/mandatory-headers.md) - [Rate Limit](https://documentation.safecube.ai/reference/rate-limit.md) ## API Endpoints: Creating and Managing My Account - [Monitoring API LOGS](https://documentation.safecube.ai/reference/monitoring-api-logs.md) - [Monitor your credit consumption](https://documentation.safecube.ai/reference/monitor-your-credit-consumption.md) ## API Endpoints: Container Tracking API - [🚀Getting Started With Container Tracking API](https://documentation.safecube.ai/reference/getting-started-with-container-tracking-api.md): A quick guide to understand Container Tracking basics and best practices and get started in just a few steps. - [📍Get Shipment Location](https://documentation.safecube.ai/reference/get-shipment-location.md): How to retrieve shipment location with container tracking API? - [🗺️Display the shipment route](https://documentation.safecube.ai/reference/️display-the-shipment-route.md): Understand how to get shipment route from the container tracking API - [🧰 Container Tracking Resources](https://documentation.safecube.ai/reference/container-tracking-ressources.md) - [Supported Sealines](https://documentation.safecube.ai/reference/supported-sealines.md) - [Possible Status & Event Codes](https://documentation.safecube.ai/reference/possible-status-event-codes.md): List of possible Status & Event Codes - [Possible Error codes](https://documentation.safecube.ai/reference/possible-error-codes.md) - [Sandbox & Testing](https://documentation.safecube.ai/reference/testing-shipments.md): Test shipments are available for testing api integration at no cost. - 🗺️Guides - [Detect Demurrage risk](https://documentation.safecube.ai/reference/detect-demurrage-risk.md): Detect Demurrage risk with Container Tracking API - Shipment - [Retrieve shipment traking data](https://documentation.safecube.ai/reference/getshipmentdetail.md) - Shipment Format - [Retrieve shipment tracking data in a Searates-compatible format](https://documentation.safecube.ai/reference/getshipmentsearatesformat.md):
Returns the same tracking data as GET /shipment, formatted to be compatible with the Searates "Tracking by any number" response.
Enables a field-by-field comparison with… - Sealine - [Retrieve available sealines](https://documentation.safecube.ai/reference/getsealinedetails.md) - Usage - [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages.md):
The endpoint allows you to retrieve your monthly usages of the API
- [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)](https://documentation.safecube.ai/reference/retrieveshipmentusages.md) ## API Endpoints: Webhook api - [🚀Getting Started with Webhooks](https://documentation.safecube.ai/reference/getting-started-with-webhooks.md): Creating and setting up a webhook in Sinay’s webhook API can be done in 2 ways. - [Adding shipments](https://documentation.safecube.ai/reference/react-to-shipmentinerror.md): Understanding webhook events when adding shipments to your endpoint. - [Testing your endpoint](https://documentation.safecube.ai/reference/testing-your-endpoint.md): A guide to testing if your webhook endpoint is functional. - [Detect and Recover webhook failures](https://documentation.safecube.ai/reference/detect-and-recover-webhook-failures.md) - [Shipment usage](https://documentation.safecube.ai/reference/shipment-usage.md): Optimize your tracking to avoid overages. - [🧰 Webhook Resources](https://documentation.safecube.ai/reference/webhook-ressources.md) - [🔄️Synchronous and Asynchronous tracking](https://documentation.safecube.ai/reference/️synchronous-and-asynchronous-tracking.md): Synchronous vs Asynchronous APIs: Choosing Between Container Tracking and Webhook - [Webhooks as PUSH API](https://documentation.safecube.ai/reference/using-webhooks-as-a-push-api.md): Webhooks API can be used either to notify your users about specific change in the data AND/OR to update your data automatically (without making any Container API requests). Find here the… - [Possible Events](https://documentation.safecube.ai/reference/possible-webhook-events.md) - [Auto removal policy](https://documentation.safecube.ai/reference/auto-removal-policy.md): Shipments are automatically unsubscribed from your endpoints. Here is when. - Endpoint - [Create Endpoint](https://documentation.safecube.ai/reference/v1endpointcreate.md): Create a new endpoint for the application. Specify the url you wish to receive webhooks and the events you wish to track. When `secret` is `null` the secret is automatically generated (recommended) - [List Endpoints](https://documentation.safecube.ai/reference/v1endpointlist.md): List the application's endpoints. - [Get Endpoint](https://documentation.safecube.ai/reference/v1endpointget.md): Retrieve an endpoint parameters. - [Update Endpoint](https://documentation.safecube.ai/reference/v1endpointupdate.md): Update an endpoint. This will replace all your endpoint parameters with the one you specify. If you don't specify a parameter, it will be erased. If you wish to update an endpoint partially, use… - [Delete Endpoint](https://documentation.safecube.ai/reference/v1endpointdelete.md): Delete an endpoint. - [Patch Endpoint](https://documentation.safecube.ai/reference/v1endpointpatch.md): Partially update an endpoint. - [Get Endpoint Secret](https://documentation.safecube.ai/reference/v1endpointget-secret.md): Get the endpoint's signing secret. This is used to verify the authenticity of the webhook. For more information please refer to [the consuming webhooks… - [Rotate Endpoint Secret](https://documentation.safecube.ai/reference/v1endpointrotate-secret.md): Rotates the endpoint's signing secret. The previous secret will be valid for the next 24 hours. - [Endpoint Stats](https://documentation.safecube.ai/reference/v1endpointget-stats.md): Get basic statistics for the endpoint, since max 28 days. Will return amount of messages sent with success, failed or still in progress. - [Recover Failed Webhooks](https://documentation.safecube.ai/reference/v1endpointrecover.md): Resend all failed messages since a given time. - [Replay Missing Webhooks](https://documentation.safecube.ai/reference/v1endpointreplay.md): Replays messages to the endpoint. Only messages that were created after `since` will be sent. Messages that were previously sent to the endpoint are not resent. - [Get Endpoint Headers](https://documentation.safecube.ai/reference/v1endpointget-headers.md): Get the additional headers to be sent with the webhook - [Update Endpoint Headers](https://documentation.safecube.ai/reference/v1endpointupdate-headers.md): Set the additional headers to be sent with the webhook This can be used in case your infrastructure requires additional security. This will replace all previously sent headers. Use PATCH to update… - [Patch Endpoint Headers](https://documentation.safecube.ai/reference/v1endpointpatch-headers.md): Partially set the additional headers to be sent with the webhook - [Send Event Type Example Message](https://documentation.safecube.ai/reference/v1endpointsend-example.md): Send an example message for a specific event. Note that this will only sent demo data (and not real tracking data) This can only be used to send event types that are configured for the endpoint. - Easy-shipment - [Add shipments asynchronously](https://documentation.safecube.ai/reference/easy-shipment-asynchronous.md): Add container or BL or BK to one or multiple endpoints with their container / BL / BK numbers. Your request will immediatelly be acknowledged. You can then monitor if you shipment has been correctly… - [Get the list of shipments for all your endpoints](https://documentation.safecube.ai/reference/v1easyshipmentget.md): Get all container / bl / bk that are currently monitored by each of your endpoints - [Update shipments to endpoints](https://documentation.safecube.ai/reference/v1easyshipmentupdate.md): You can update container or BL or BK to one or multiple endpoints with their container / BL / BK numbers. Note that all the container / bl / bk will be replaced by the one provided in your request.… - [Delete shipments to endpoints](https://documentation.safecube.ai/reference/v1easyshipmentdelete.md): You can delete container or BL or BK to one or multiple endpoints by their container / BL / BK numbers. Note that the container / bl / bk provided will be deleted for endpoint provided - Application - [Get dashboard url](https://documentation.safecube.ai/reference/v1applicationdashboard.md): Get your dashboard url. Open it with a web browser to monitor your webhook endpoints. - Usages - [Retrieve list of shipments called with the API](https://documentation.safecube.ai/reference/retrieveshipmentusages-webhooks.md): Retrieve the list of shipments called with the API within the provided timeframe, that usages have a minimum resolution of a month (you cant select the usage for one week for example, the usage will… ## API Endpoints: [BETA] Ports Intelligence API - Port intelligence ressources - [Port Occupation](https://documentation.safecube.ai/reference/port-coverage.md) - Ports - [Search Port Details by its name or unlocode](https://documentation.safecube.ai/reference/searchportdetails.md): Retrieve detailed informations about a specific port by its UNLOCODE. It include the berth occupation rate and the difference with the average one. - [Get Port Details by unlocode](https://documentation.safecube.ai/reference/getportdetails.md): Retrieve detailed informations about a specific port by its UNLOCODE. It include the berth occupation rate and the difference with the average one. - [Get Vessels in port](https://documentation.safecube.ai/reference/getvesselsinport.md): Retrieve a list of vessels currently in the specified port ## API Endpoints: API Safecube Shipment Management - [Get Started with Safecube Shipment Management API](https://documentation.safecube.ai/reference/get-started-with-safecube-shipment-management-api.md): Get access, create shipments and retrieve their public sharing link. - [Embed Safecube within an Iframe](https://documentation.safecube.ai/reference/embed-safecube-with-an-iframe.md) - Shipments - [Create shipments](https://documentation.safecube.ai/reference/post_public-shipments.md):Endpoint that allows to create shipments in Safecube web application. The shipment creation is asynchronous.
When Safecube will have processed your request entirely, you will receive a… - [Delete multiple shipments](https://documentation.safecube.ai/reference/delete_public-shipments.md): Endpoint that allows to delete shipments from the Safecube web application. Deleted shipments will not be updated, trigger alerts or be charged. - [Get multiple shipments](https://documentation.safecube.ai/reference/post_public-shipments-search.md): Endpoint that searchs for shipments in the web application and returns the public shipment link. ## API Endpoints: API CO2 emission - Co2 computation - [Retrieve co2 consumption for a trip from one port to another.](https://documentation.safecube.ai/reference/computeco2.md):
This endpoint is used to compute the CO2 emissions of a TEU during its journey from a port to another port.
To identify the vessel, you can use the IMO… - Usage - [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages-4.md):
The endpoint allows you to retrieve your monthly usages of the API
## API Endpoints: Vessel ETA Calculator API - [About the API](https://documentation.safecube.ai/reference/about-the-api.md) - Estimated time arrival - [ETA computation](https://documentation.safecube.ai/reference/computeeta.md):This endpoint is used to compute the Estimated Time of Arrival of any vessel.
To compute the ETA of a vessel, we need information concerning the vessel, the departure… - Usage - [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages-1.md):
The endpoint allows you to retrieve your monthly usages of the API
## API Endpoints: API Noise emission - Noise computation - [Retrieve Noise emitted for a trip from one port to another.](https://documentation.safecube.ai/reference/computenoise.md):This endpoint is used to compute the SEL and noises emissions in multiple frequencies of a vessel during its journey from a port to another port and compare them to the recommended thresholds.
… - Usage - [Retrieve your monthly usages](https://documentation.safecube.ai/reference/retrieveusages-3.md):The endpoint allows you to retrieve your monthly usages of the API
## API Endpoints: Congestion API - [Congestion](https://documentation.safecube.ai/reference/congestion.md) - [Congestion API Coverage](https://documentation.safecube.ai/reference/congestion-api-coverage.md) - Congestion API Ressources - Congestion - [Retrieve aggregated congestion data for multiple ports](https://documentation.safecube.ai/reference/retrievecongestionaggregatebatch.md):Returns congestion, time-in-port statistics, and vessel counts for a list of ports.
Maximum 10 ports per request.
- [Retrieve aggregated congestion data for a port](https://documentation.safecube.ai/reference/retrievecongestionaggregate.md):Returns congestion, time-in-port statistics, and vessel counts for a given port.
- Consumption - [Retrieve the current credit consumption period](https://documentation.safecube.ai/reference/retrievecurrentconsumptionperiod.md) - [Retrieve all credit consumption periods](https://documentation.safecube.ai/reference/retrieveconsumptionperiods.md) ## Changelog - [Enhanced Alert Management with Priority Levels](https://documentation.safecube.ai/changelog/enhanced-alert-management-with-priority-levels.md) - [Automatic Shipment Archiving](https://documentation.safecube.ai/changelog/automatic-shipment-archiving.md) - [Kanban View & Vessel Schedules](https://documentation.safecube.ai/changelog/kanban-view-vessel-schedules.md) - [New Port & Vessel intelligence APIs](https://documentation.safecube.ai/changelog/new-port-vessel-intelligence-apis.md) - [New Analytics Dashboard](https://documentation.safecube.ai/changelog/new-analytics-dashboard.md) - [New module added: Vessel Tracking](https://documentation.safecube.ai/changelog/new-module-added-vessel-tracking.md) - [New Warning in API - Split BL](https://documentation.safecube.ai/changelog/new-warning-in-api-split-bl.md) - [Embed & Brand Safecube with New Premium Tools](https://documentation.safecube.ai/changelog/embed-brand-safecube-with-new-premium-tools.md) - [Customize Your Shipment List View](https://documentation.safecube.ai/changelog/customize-your-shipment-list-view.md) - [New API Field – Container Size & Type](https://documentation.safecube.ai/changelog/new-api-field-container-size-type.md)