Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-24710198.3 KB
Webhooks

Test a Webhook Endpoint

Send a simulated tracking event to your registered webhooks

post/ship/webhooktest/

Request body

carrierstring required

Carrier name from the shipment (e.g. fedex, dhl, estafeta). Must match the carrier of the shipment associated with the provided tracking number.

trackingNumberstring required

Tracking number of a shipment previously generated in your account. The shipment must belong to the authenticated company.

status'Shipped' | 'Delivered' | 'Canceled' | 'Picked Up' required

Status name to simulate. Accepted values: Delivered, Shipped, Canceled, Picked Up. These values also update the shipment's status record in non-production environments.

Example request

{
  "carrier": "fedex",
  "trackingNumber": "1234567890",
  "status": "Delivered"
}

Response

Webhook test triggered successfully

metastring

Action name — always webhookTest for this endpoint

Example response

{
  "meta": "webhookTest",
  "data": {
    "message": "success"
  }
}