Sign in

v1

latestOpenAPI 3.0.02026-07-131658213.4 KB
Webhooks

Register webhook (billable)

Register a webhook for parcel tracking. Supports 2 modes:

  • recurring: true — Continuous monitoring until delivery (subscription). Recommended for most integrations. Register once and receive push notifications whenever the tracking status changes. Ideal for keeping your database in sync with delivery progress.
  • recurring: false — Query once only (one-time, default). Useful for one-off lookups where you don't need ongoing updates.

Why use webhooks? Polling /v2/track repeatedly wastes your request quota. A single parcel typically has 5–10 status changes over its lifecycle. With webhooks, you receive only those 5–10 updates instead of making hundreds of polling requests.

Billable API, supports up to 500 items per registration.

post/v2/webhooks/register

Request body

recurringboolean

Tracking mode (optional, default: false)

  • false: Query once only (default, safe) → webhookEndpointId optional
  • true: Continuous monitoring (explicit request required) → webhookEndpointId required
webhookEndpointIdstring

Pre-registered Webhook Endpoint ID

  • Required when recurring: true (validated by middleware)
  • Optional when recurring: false
  • If provided, sends POST on completion; if omitted, no notification sent
  • Must register a Webhook Endpoint first

Response

Webhook registered successfully

OR