API ReferenceWebhooks

Esta página solo está disponible en inglés.

Send a test event

POST /rest/v1/webhook_endpoints/{id}/test

POST
/webhook_endpoints/{id}/test

Delivers one signed test event of type (default: the endpoint's first subscribed type) right away. data.object is a sample of the real shape for that type (an order, a listing, a product…) built from fake records (TEST-SKU-1, TEST-1001…), and data.test is true: your handler runs exactly as on a real event; skip writes when data.test is set. An unknown type answers 422 validation_failed. Required scope: webhooks:manage.

AuthorizationBearer <token>

Authorization: Bearer nbl_live_... (or nbl_test_... for test mode). Test-mode writes are validated and simulated but never persisted and never touch channels; simulated results are marked simulated.

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/webhook_endpoints/string/test" \  -H "Content-Type: application/json" \  -d '{}'
{  "delivered": true,  "response_status": 0}

Última actualización el 18 de octubre de 2026

¿Necesitas ayuda?

Escríbenos y te responde una persona, normalmente en un día laborable.