Webhook-beheer (Webhook Management)

Beheer uw webhook-endpoints om realtime gebeurtenismeldingen te ontvangen. U kunt maximaal 10 webhook-endpoints per organisatie registreren.

Webhook aanmaken

POST /webhooks

Verzoeklichaam

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

Veld	Type	Verplicht	Beschrijving
`url`	string	Ja	HTTPS-endpoint-URL om webhook-afleveringen te ontvangen
`events`	string[]	Ja	Array van gebeurtenistypen om op te abonneren (of `["*"]` voor alles)
`description`	string	Nee	Een leesbare beschrijving voor dit endpoint

Antwoord (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"
}

Belangrijk: Het signingSecret wordt alleen geretourneerd wanneer de webhook voor het eerst wordt aangemaakt. Sla het veilig op -- u heeft het nodig om inkomende webhook-handtekeningen te verifiëren. Het kan niet opnieuw worden opgehaald.

SSRF-bescherming

Webhook-URL's moeten openbaar toegankelijke HTTPS-endpoints zijn. Het volgende wordt geweigerd:

Privé-/interne IP-adressen (10.x.x.x, 172.16-31.x.x, 192.168.x.x)
Localhost- en loopback-adressen
Niet-HTTPS-URL's

Webhooks weergeven

GET /webhooks

Antwoord

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

Webhook bijwerken

PUT /webhooks/:id

Padparameters

Naam	Type	Verplicht	Beschrijving
`id`	string	Ja	Het webhook-ID

Verzoeklichaam

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

Alle velden zijn optioneel. Alleen opgegeven velden worden bijgewerkt.

Antwoord

Retourneert het bijgewerkte webhook-object.

Webhook verwijderen

DELETE /webhooks/:id

Padparameters

Naam	Type	Verplicht	Beschrijving
`id`	string	Ja	Het webhook-ID

Antwoord

Retourneert 204 No Content bij succes.

Webhook testen

Stuur een testgebeurtenis om te verifiëren dat uw endpoint bereikbaar is en webhook-afleveringen correct verwerkt.

POST /webhooks/:id/test

Padparameters

Naam	Type	Verplicht	Beschrijving
`id`	string	Ja	Het webhook-ID

Antwoord

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

Als de testaflevering mislukt:

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