GETAPI keyFree

Webhook limits and counters

GETapi.navo24.com/v1/tracking/webhooks/usage

Your webhook limits (active endpoints, sustained delivery rate, burst) and the delivery counters for the current UTC day. Deliveries above the rate wait in the queue, they are not dropped.

Not counted: webhook management is an account path and spends no call quota. The event deliveries we send are free. See what counts as a successful request.

Response schema

102 fields

Generated from the OpenAPI spec. Nested exactly as the JSON is. Open a branch to read its fields; hover a name for the full dot-path.

okboolean

Whether the request succeeded.

dataobject

The payload. Everything an endpoint returns sits under this key.

limitsobject

active_endpoint_limitinteger

deliveries_per_secondnumber

burst_deliveriesinteger

active_endpointsinteger

daystring

usageobject

enqueuedinteger

attemptedinteger

deliveredinteger

failedinteger

deadinteger

updated_atstring

When the counters last changed.

idstring

Existing record id. Only on status 401, 403, 429, 500 and 504.

archived_atstring | null

When tracking stopped. Only on status 401, 403, 429, 500 and 504.

archived_reasonstring | null

Null when your account archived it, otherwise the reason our archiver closed it. Only on status 401, 403, 429, 500 and 504.

resumeobject

Only on status 401, 403, 429, 500 and 504.

methodstring

pathstring

bodyobject

identifierstring

The reference to add again.

api_versionstring

The response contract this build answers, as a date (YYYY-MM-DD).

errorobject

Only on status 401, 403, 429, 500 and 504.

codestring

Machine readable error code.

messagestring

Human readable explanation.

severity"info" | "warning" | "error"

How serious the error is.

retryableboolean

True.

referencestring

The reference.

retry_after_secondsinteger

Seconds to wait.

fieldsstring[]

Offending fields.

user_messagestring

CONTAINER_QUOTA_EXCEEDED only.

credits_requiredinteger | null

Tokens this request needs.

credits_balanceinteger | null

Tokens the wallet holds.

top_up_urlstring

Where to top up.

packagesarray

Plans on offer.

packages[]object

planstring

Plan key.

creditsinteger

Tokens per month.

usdnumber

Monthly price in USD.

reasonstring

CARRIER_NOT_IDENTIFIED only.

waited_secondsinteger

CARRIER_NOT_IDENTIFIED, timed out only.

retry_withstring

member_limitinteger | null

The member cycle limit.

member_spentinteger | null

Tokens the member has used this cycle.

member_remaininginteger | null

Tokens left for the member.

retry_afterinteger

Seconds until the next refresh is allowed.

request_idstring

requestedstring | null

supported_versionsstring[]

oldest_supportedstring

lateststring

docsstring

progressobject

carrier_codestring

carrier_namestring | null

carrier_identifiedtrue

registered_atstring | null

last_checked_atstring | null

next_check_after_seconds60

unresolved_reasonstring

outcomestring

One of: SEALINE_HASNT_PROVIDE_INFO, NO_EVENTS, WRONG_NUMBER, REFERENCE_REQUIRED, LINE_NOT_SUPPORTED, PENDING, UNRESOLVED.

outcome_classstring

sealine_statusstring | null

previous_tripobject | null

The trip before yours for this box, when the line still reports it.

linestring | null

The line that answered, as its SCAC.

last_eventobject

codestring | null

descriptionstring | null

locationstring | null

unlocodestring | null

datetimestring | null

eventsarray

events[]object

codestring | null

descriptionstring | null

locationstring | null

unlocodestring | null

datetimestring | null

ended_atstring | null

lessor_notestring | null

A note for leasing-company accounts when no line holds the box yet.

identified_linestring | null

identified_partystring | null

identified_party_role"current_lessee" | null

required_reference_types("bill_of_lading" | "booking")[] | null

connector_statusstring | null

One of: in_progress, not_supported, connected, reference_required.

notification_interest_availableboolean

carrier_noticeobject | null

Latest reference-specific reply from the named carrier. Only on status 401, 403, 429, 500 and 504.

carrier_code"ZIMU" | "MAEU" | "CHVW"

referencestring

reference_type"container" | "bl" | "booking"

statusstring

One of: other_carrier, temporarily_unavailable, not_found, invalid_reference, SHIPMENT_CANCELLED, no_longer_available.

messagestring

checked_atstring

suggested_carrierstring | null

suggested_urlstring | null

carrier_hint_appliedboolean

Present when the line named was not used. Only on status 401, 403, 429, 500 and 504.

carrier_hint_codestring

Known line that cannot be asked. Only on status 401, 403, 429, 500 and 504.

upgradeobject | null

CONTAINER_QUOTA_EXCEEDED only. Only on status 401, 403, 429, 500 and 504.

planstring

Next plan.

monthly_eurnumber | null

Monthly price.

annual_eurnumber | null

Annual price.

warningstring

Why the line named was not used. Only on status 401, 403, 429, 500 and 504.

Errors

A failure carries { "ok": false, "error": { "code", "message", "severity" } }. Branch on the code, and log the message.

UNAUTHORIZED401

The key is missing, malformed or revoked.

INTERNAL_ERROR500

We could not read the limits or the counters. Retry.

curl 'https://api.navo24.com/v1/tracking/webhooks/usage' \
  -H "Authorization: Bearer tmcp_YOUR_API_KEY"

const res = await fetch("https://api.navo24.com/v1/tracking/webhooks/usage", {
  headers: {
    "Authorization": "Bearer tmcp_YOUR_API_KEY"
  }
});
const data = await res.json();

import requests

res = requests.get(
    "https://api.navo24.com/v1/tracking/webhooks/usage",
    headers={"Authorization": "Bearer tmcp_YOUR_API_KEY"},
)
data = res.json()

Response

{
  "api_version": "2026-08-04",
  "ok": true,
  "data": {
    "limits": {
      "active_endpoint_limit": 3,
      "deliveries_per_second": 5,
      "burst_deliveries": 25
    },
    "active_endpoints": 1,
    "day": "2026-11-10",
    "usage": {
      "enqueued": 4,
      "attempted": 4,
      "delivered": 3,
      "failed": 1,
      "dead": 0,
      "updated_at": "2026-11-10T08:00:00.000Z"
    }
  }
}