Skip to content
Navo24Navo24
PATCHAPI keyFree

Update an endpoint

PATCHapi.navo24.com/v1/tracking/webhooks/{id}

Change the URL, the subscription, the label or the enabled state. Send only the fields you want to change. Setting active to true also resets failure_count to zero, which is how you bring back an endpoint we auto-disabled. A url that is not https is ignored rather than rejected, so read the returned url back. Answers 404 NOT_FOUND for an unknown id.

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.

Path parameters

idstringrequired

Endpoint id.

Request body

urlstring

New URL. Ignored unless it starts with https://.

event_typesstring[]

Replaces the subscription outright. Unrecognised names are dropped. Accepted values: container_arrived, container_available, container_delivered, customs_hold, vessel_departed, eta_changed, container_misrouted, demurrage_started, demurrage_warning, schedule_disruption, shipment_updated and api_change_announced.

descriptionstring

New label.

activeboolean

Enable or disable. True also clears failure_count.

Response schema

99 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

A registered webhook endpoint.

idstring

Stable identifier for the record. On the tracking endpoints this is the container UUID, except on a portfolio summary row, where it is the container number.

urlstring

Where we POST the events.

event_typesstring[]

The stored subscription, after unrecognised names were filtered out. One of: api_change_announced, container_arrived, container_available, container_delivered, container_misrouted, customs_hold, demurrage_started, demurrage_warning, eta_changed, schedule_disruption, shipment_updated, vessel_departed, vessel_rollover.

descriptionstring | null

The carrier own phrasing for the event, falling back to our word for the code.

activeboolean

False while the endpoint is paused. A paused endpoint keeps its secret and its history.

failure_countinteger

Consecutive delivery failures.

last_delivery_atstring | null
created_atstring
disabled_atstring | null

When the endpoint was disabled.

disabled_reason"manual" | "delivery_failures" | null

Manual disable or automatic disable after repeated delivery failures.

disabled_errorstring | null

Last receiver error at automatic disable; null for manual disable or an active endpoint.

archived_atstring | null

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

archived_reasonstring | null

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

resumeobject

Only on status 400, 401, 403, 404, 409, 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 400, 401, 403, 404, 409, 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 400, 401, 403, 404, 409, 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 400, 401, 403, 404, 409, 429, 500 and 504.

carrier_hint_codestring

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

upgradeobject | null

CONTAINER_QUOTA_EXCEEDED only. Only on status 400, 401, 403, 404, 409, 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 400, 401, 403, 404, 409, 429, 500 and 504.

curl -X PATCH 'https://api.navo24.com/v1/tracking/webhooks/3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10' \
  -H "Authorization: Bearer tmcp_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"active":true}'
Response
{
  "api_version": "2026-08-04",
  "ok": true,
  "data": {
    "id": "3f1c9a4e-7b52-4f0e-9a41-2c9d5e6b8a10",
    "url": "https://example.com/navo-docs-capture",
    "event_types": [],
    "description": "Docs capture, staging only",
    "active": false
  }
}