Test-send webhook

Sends one synthetic event of the given topic straight to the endpoint's URL — signed exactly like a real delivery (same HMAC scheme, same headers), through the same SSRF-safe request path — and returns the receiver's raw response inline, synchronously.

This deliberately bypasses the whole delivery system: no webhook_delivery row is created, it never enters the retry ladder, it doesn't count toward the circuit breaker, and it won't show up in GET .../deliveries. It exists purely to answer "does my receiver accept the URL/auth/signature correctly" in one request, in seconds, while you're setting up an integration — not to simulate production delivery behavior. Use this before your first real subscription goes live; don't rely on it to test retry handling on your end, since there's only ever one attempt.

The synthetic payload's data is a fixed placeholder ({"test": true, "note": "Synthetic event from POST /v4/webhooks/:id/test"}), not a realistic example of that topic's real shape — for that, see the exampleData field on GET /v4/webhooks/topics.

application/json

Always 200 from commons-api's side — this reports the outcome of the test call, it doesn't reflect your receiver's status code as this endpoint's own status.

Bodyapplication/json

curl --location '/v4/webhooks//test' \ --header 'Authorization: Bearer eyJhbGciOiJFZERTQSIsImtpZCI6Im1haW4ta2V5IiwidHlwIjoiSldUIn0...' \ --header 'Content-Type: application/json' \ --data '{ "topic": "contact.created" }'

Request

Responses