Správa webhooků (Webhook Management)

Spravujte své webhookové endpointy pro příjem oznámení o událostech v reálném čase. Můžete zaregistrovat až 10 webhookových endpointů na organizaci.

Vytvoření webhooku

POST /webhooks

Tělo požadavku

{
	"url": "https://yourapp.com/webhooks/vignetim",
	"events": ["order.completed", "order.failed"],
	"description": "Production order notifications"
}

Odpověď (201 Created)

{
	"id": "wh-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"url": "https://yourapp.com/webhooks/vignetim",
	"events": ["order.completed", "order.failed"],
	"description": "Production order notifications",
	"active": true,
	"signingSecret": "whs_a1b2c3d4e5f6789012345678901234567890abcdef",
	"createdAt": "2026-03-20T14:30:00.000Z"
}

Důležité: signingSecret je vrácen pouze při prvním vytvoření webhooku. Uložte ho bezpečně -- budete ho potřebovat k ověřování příchozích podpisů webhooků. Nelze ho znovu získat.

Ochrana proti SSRF

URL webhooků musí být veřejně dostupné HTTPS endpointy. Následující jsou odmítnuty:

• Privátní/interní IP adresy (10.x.x.x, 172.16-31.x.x, 192.168.x.x)
• Localhost a loopback adresy
• Adresy bez HTTPS

Výpis webhooků

GET /webhooks

Odpověď

{
	"data": [
		{
			"id": "wh-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
			"url": "https://yourapp.com/webhooks/vignetim",
			"events": ["order.completed", "order.failed"],
			"description": "Production order notifications",
			"active": true,
			"consecutiveFailures": 0,
			"createdAt": "2026-03-20T14:30:00.000Z",
			"updatedAt": "2026-03-20T14:30:00.000Z"
		}
	]
}

Aktualizace webhooku

PUT /webhooks/:id

Parametry cesty

Tělo požadavku

{
	"url": "https://yourapp.com/webhooks/vignetim-v2",
	"events": ["*"],
	"description": "Updated to receive all events"
}

Všechna pole jsou volitelná. Aktualizována jsou pouze zadaná pole.

Odpověď

Vrací aktualizovaný objekt webhooku.

Smazání webhooku

DELETE /webhooks/:id

Parametry cesty

Odpověď

Při úspěchu vrací 204 No Content.

Testování webhooku

Odešlete testovací událost k ověření, že váš endpoint je dosažitelný a správně zpracovává doručení webhooků.

POST /webhooks/:id/test

Parametry cesty

Odpověď

{
	"success": true,
	"statusCode": 200,
	"responseTime": 145,
	"message": "Test webhook delivered successfully"
}

Pokud testovací doručení selže:

{
	"success": false,
	"statusCode": 500,
	"responseTime": 10000,
	"message": "Webhook endpoint returned non-2xx status code"
}