Send a test delivery to a tracking webhook.

Sends one signed tracking.webhook.test event to the webhook's URL now and answers with what your endpoint said. A 2xx proves the URL is reachable and allowed and TLS works, without waiting for a real shipment. Shipwell can't see whether you verified the signature: make your handler reject a bad one, so a 2xx also means your check passed.

Nothing is stored or retried. The response is 200 whether or not your endpoint accepted the test; read delivered.

SecurityAPIKeyHeader
Request
path Parameters
webhook_id
required
string (Webhook Id)
header Parameters
X-Shipwell-Version
string (X-Shipwell-Version)

Pins this request to the API as it behaved on the given ISO date, e.g. 2026-08-25. Omitted or unparseable means the oldest behaviour, so a client that never sends it keeps the behaviour it was written against.

Responses
200

Successful Response

Response Schema: application/json
required
object (TrackingWebhookTestResult)
400

Validation Error

403

Tracking webhooks are not enabled for your company.

404

No such webhook for this company.

500

An unknown internal server issue occured while processing a request. A report is created and logged.

503

Tracking webhooks are not enabled in this environment yet.

post/tracking/webhooks/{webhook_id}/test
Request samples
Response samples
application/json
{
  • "data": {
    }
}
Copyright © Shipwell 2025. All right reserved.