> For the complete documentation index, see [llms.txt](https://api-portal.novapost.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-portal.novapost.com/methods/ua/overview/webhooks/test-webhook.md). # Тестовий webhook ## Перевірка тестового webhook > Цей метод дозволяє перевірити роботу webhook. Для успішної відповіді потрібна щонайменше одна активна підписка.\ > \ > Webhook-запити за замовчуванням надсилаються з Content-Type \`application/json\`.\ > \ > 🔹\*\*Поведінка тестового webhook:\*\*\
\ > Метод повертає відповідь-підтвердження про те, що тестовий webhook-запит було надіслано.\ > Подія webhook з даними відстеження надсилається на URL, вказаний підписником.\ > \ > Це підтвердження \*\*не гарантує\*\*, що ваш сервер отримав запит.\ > Остаточну перевірку виконуйте за логами свого сервера: у них має з’явитися вхідний POST-запит із коректним секретним заголовком.\ > \ > Тестовий webhook містить синтетичну історію статусів. Він не перевіряє ані відповідність реальному відправленню, ані налаштування \`eventTypes\`.\ > \ > 🔹\*\*Структура тіла webhook-запиту:\*\*\
\ > Тіло webhook-запиту має наступний вигляд:\ > \`\`\`json\ > {\ > "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-сповіщення містить новий доданий статус і всі раніше доставлені статуси.
````json {"openapi":"3.0.0","info":{"title":"API Nova Post","version":"1.0.0"},"tags":[{"name":"Webhooks"}],"servers":[{"description":"sandbox","url":"https://api-stage.novapost.com/v.1.0/"},{"description":"production","url":"https://api.novapost.com/v.1.0/"}],"security":[{"JWT":[]}],"components":{"securitySchemes":{"JWT":{"type":"apiKey","in":"header","name":"Authorization","description":"Авторизаційний JWT-токен із терміном дії 1 година в заголовку"}},"responses":{"Unauthorized":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"NotFound":{"description":"The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Validation":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"Time-out":{"description":"Connection time-out","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"errors":{"type":"object","properties":{"":{"type":"string"}}}}}}},"paths":{"/tracking-push/subscribers/test-webhook":{"post":{"summary":"Перевірка тестового webhook","description":"Цей метод дозволяє перевірити роботу webhook. Для успішної відповіді потрібна щонайменше одна активна підписка.\n\nWebhook-запити за замовчуванням надсилаються з Content-Type `application/json`.\n\n🔹**Поведінка тестового webhook:**
\nМетод повертає відповідь-підтвердження про те, що тестовий webhook-запит було надіслано.\nПодія webhook з даними відстеження надсилається на URL, вказаний підписником.\n\nЦе підтвердження **не гарантує**, що ваш сервер отримав запит.\nОстаточну перевірку виконуйте за логами свого сервера: у них має з’явитися вхідний POST-запит із коректним секретним заголовком.\n\nТестовий webhook містить синтетичну історію статусів. Він не перевіряє ані відповідність реальному відправленню, ані налаштування `eventTypes`.\n\n🔹**Структура тіла webhook-запиту:**
\nТіло webhook-запиту має наступний вигляд:\n```json\n{\n \"number\": \"SHPL0000000001\",\n \"scheduled_delivery_date\": \"2024-11-20T20:03:00.000000Z\",\n \"history_tracking\": [\n {\n \"code\": \"4\",\n \"code_name\": \"On the way\",\n \"country_code\": \"UA\",\n \"settlement\": \"Kyiv\",\n \"date\": \"2024-11-19T09:32:05.000000Z\"\n },\n {\n \"code\": \"112\",\n \"code_name\": \"Change of delivery date\",\n \"country_code\": \"\",\n \"settlement\": \"\",\n \"date\": \"2024-11-19T09:33:56.000000Z\"\n }\n ]\n}\n```\nіз такими параметрами:\n- `number` — номер відправлення.\n- `scheduled_delivery_date` — заплановані дата та час доставки у форматі ISO 8601.\n- `history_tracking` — масив об’єктів статусів відстеження.\n - `code` — код статусу відстеження.
Докладніше про коди статусів відстеження дивіться в описі параметра `currentStatus.statusCode` у відповіді методу Повне відстеження.\n - `code_name` — назва статусу відстеження.\n - `country_code` — код країни, у якій було зафіксовано статус.\n - `settlement` — назва населеного пункту.\n - `date` — дата та час події статусу.\n\nТіло webhook-запиту містить щонайменше один статус відстеження.
\nКожне наступне webhook-сповіщення містить новий доданий статус і всі раніше доставлені статуси.\n","operationId":"testWebhook","tags":["Webhooks"],"requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"numbers":{"type":"array","description":"Тестовий номер відправлення завжди має значення `SHPL0000000001`.","items":{"type":"string"}},"id":{"type":"string","description":"Унікальний ідентифікатор підписки, яку перевіряєте."},"cid":{"type":"string","description":"Унікальний ідентифікатор клієнта. Це єдиний метод, у якому його потрібно передавати явно."}},"required":["id","cid","numbers"]}}}},"responses":{"200":{"description":"Тестовий webhook успішно надіслано.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"string","description":"Повідомлення-підтвердження про успішне виконання тесту."}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"422":{"$ref":"#/components/responses/Validation"},"503":{"$ref":"#/components/responses/Time-out"}}}}}} ```` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://api-portal.novapost.com/methods/ua/overview/webhooks/test-webhook.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.