A test delivery.Webhook

Sent only by POST /tracking/webhooks/{webhook_id}/test. Signed like every other delivery.

Headers on every delivery

Header Value
Content-Type application/json; charset=utf-8
User-Agent shipwell-webhooks
X-Shipwell-Timestamp ISO-8601 time the request was signed
X-Shipwell-Signature hex HMAC-SHA256 of "{X-Shipwell-Timestamp};{raw body}", keyed with your secret

Answer with any 2xx within 10 seconds. A test is sent once and never retried.

Request
header Parameters
X-Shipwell-Timestamp
required
string

ISO-8601 time the request was signed.

Example: 2026-09-26T14:05:31.123456+00:00
X-Shipwell-Signature
required
string

Hex HMAC-SHA256 of "{X-Shipwell-Timestamp};{raw body}" keyed with your webhook secret. Compare it to your own computation before trusting the body.

Request Body schema: application/json
required
id
required
string (Id)

Event id, new for every test: a test is sent once, never retried.

occurred_at
required
string <date-time> (Occurred At)
webhook_id
required
string (Webhook Id)

The subscription this delivery is for.

required
object (TrackingWebhookSource)
Custom Data (object) or Custom Data (null) (Custom Data)
Default: null

Echoed from the subscription.

event_name
required
string (Event Name)
Value: "tracking.webhook.test"
sequence
integer (Sequence)
Default: 0

Always 0: a test belongs to no shipment.

required
object (TrackingWebhookTestDetails)
Responses
2XX

Accepted.

Request samples
application/json
{
  • "id": "string",
  • "occurred_at": "2019-08-24T14:15:22Z",
  • "webhook_id": "string",
  • "source": {
    },
  • "custom_data": null,
  • "event_name": "tracking.webhook.test",
  • "sequence": 0,
  • "details": {
    }
}
Copyright © Shipwell 2025. All right reserved.