Тестовий webhook

Перевірка тестового webhook

post

/tracking-push/subscribers/test-webhook

Цей метод дозволяє перевірити роботу webhook. Для успішної відповіді потрібна щонайменше одна активна підписка.

Webhook-запити за замовчуванням надсилаються з Content-Type application/json.

🔹Поведінка тестового webhook: Метод повертає відповідь-підтвердження про те, що тестовий webhook-запит було надіслано. Подія webhook з даними відстеження надсилається на URL, вказаний підписником.

Це підтвердження не гарантує, що ваш сервер отримав запит. Остаточну перевірку виконуйте за логами свого сервера: у них має з’явитися вхідний POST-запит із коректним секретним заголовком.

Тестовий webhook містить синтетичну історію статусів. Він не перевіряє ані відповідність реальному відправленню, ані налаштування eventTypes.

🔹Структура тіла webhook-запиту: Тіло webhook-запиту має наступний вигляд:

{
  "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"
    }
  ]
}

із такими параметрами:

• number — номер відправлення.
• scheduled_delivery_date — заплановані дата та час доставки у форматі ISO 8601.
• history_tracking — масив об’єктів статусів відстеження.

  • code — код статусу відстеження. Докладніше про коди статусів відстеження дивіться в описі параметра currentStatus.statusCode у відповіді методу Повне відстеження.
  • code_name — назва статусу відстеження.
  • country_code — код країни, у якій було зафіксовано статус.
  • settlement — назва населеного пункту.
  • date — дата та час події статусу.

Тіло webhook-запиту містить щонайменше один статус відстеження. Кожне наступне webhook-сповіщення містить новий доданий статус і всі раніше доставлені статуси.

Authorizations

AuthorizationstringRequired

Авторизаційний JWT-токен із терміном дії 1 година в заголовку

Body

numbersstring[]Required

Тестовий номер відправлення завжди має значення SHPL0000000001.

Example: ["SHPL0000000001"]

idstringRequired

Унікальний ідентифікатор підписки, яку перевіряєте.

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

cidstringRequired

Унікальний ідентифікатор клієнта. Це єдиний метод, у якому його потрібно передавати явно.

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

Responses

200

Тестовий webhook успішно надіслано.

application/json

successstringOptional

Повідомлення-підтвердження про успішне виконання тесту.

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
}