API ReferenceWebhooksFire a synthetic test event to a webhook endpoint

Fire a synthetic test event to a webhook endpoint

POST/api/v1/webhooks/{webhook_id}/test

Sends a fully-signed shipment.delivered event with payload.is_test=true. Returns the WebhookDelivery record (status code, body excerpt, latency) so you can confirm your receiver handled it.

Parameters

webhook_id*

stringpath

Responses

Success body

{
  "status": 200,
  "message": "OK",
  "data": {
    "attempt_count": 0,
    "completed_at": null,
    "created_at": "2026-05-28T07:44:23.908Z",
    "event_id": "8eced096-51f4-4e1d-9b45-71fc6a89c020",
    "event_type": "shipment.created",
    "id": "IM-2026-0528-9ZNCP3-1",
    "response": null,
    "state": "pending",
    "webhook_endpoint_id": "<webhook_endpoint_id>"
  }
}

Returned object

Field	Type	Sample
status	number	200
message	string	OK
data	object	{9 keys}