Test webhook

Checking the test webhook

post

/tracking-push/subscribers/test-webhook

This endpoint allows you to test the webhook functionality. At least one active subscription is required for a successful response.

Webhook requests are sent using the application/json Content-Type by default.

🔹Test webhook behavior: The method returns a confirmation response indicating that a test webhook request was sent. A webhook event with tracking data is delivered to the subscriber endpoint.

This confirmation does not guarantee that your server received the request. Perform the final check in the logs of your own server: an incoming POST request with the correct secret header must appear there.

The test webhook contains a synthetic tracking history. It does not verify the match with a real shipment or the eventTypes settings.

🔹Webhook payload parameters: The webhook request body looks as follows:

{
  "number": "SHPL0000000001",
  "scheduled_delivery_date": "2024-11-20T20:03:00.000000Z",
  "history_tracking": [
    {
      "code": "4",
      "code_name": "On the way",
      "country_code": "UA",
      "settlement": "Kyiv",
      "date": "2024-11-19T09:32:05.000000Z"
    },
    {
      "code": "112",
      "code_name": "Change of delivery date",
      "country_code": "",
      "settlement": "",
      "date": "2024-11-19T09:33:56.000000Z"
    }
  ]
}

with the following parameters:

• number — shipment number.
• scheduled_delivery_date — scheduled delivery date and time in ISO 8601 format.
• history_tracking — array of tracking status objects.

  • code — tracking status code. For more details about tracking status codes, see the description of the currentStatus.statusCode parameter in the response of the FullTracking method.
  • code_name — tracking status name.
  • country_code — country code where the status was recorded.
  • settlement — settlement name.
  • date — timestamp of the status event.

The payload contains at least one tracking status. Each subsequent webhook delivery includes the newly added status and all previously delivered statuses.

Authorizations

AuthorizationstringRequired

Authorization JWT-token with a lifetime of 1 hour in header

Body

numbersstring[]Required

The test shipment number. Always SHPL0000000001.

Example: ["SHPL0000000001"]

idstringRequired

The unique identifier of the subscription you are checking.

Example: f5300824-58a9-496b-ac3b-bee156844fdf

cidstringRequired

Unique user identifier. This is the only method where it has to be passed explicitly.

Example: 11a111a1-a1a1-11aa-a111-111111aa1111

Responses

200

Test webhook was sent successfully.

application/json

successstringOptional

Confirmation message about successful test.

Example: true

401

Unauthorized

application/json

404

The specified resource was not found

application/json

422

Validation error

application/json

503

Connection time-out

application/json

post/tracking-push/subscribers/test-webhook

POST /v.1.0/tracking-push/subscribers/test-webhook HTTP/1.1
Host: api-stage.novapost.com/
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "numbers": [
    "SHPL0000000001"
  ],
  "id": "f5300824-58a9-496b-ac3b-bee156844fdf",
  "cid": "11a111a1-a1a1-11aa-a111-111111aa1111"
}

{
  "success": true
}