Upravljanje webhookov

Upravljajte svoje webhook končne točke za prejemanje obvestil o dogodkih v realnem času. Registrirate lahko do 10 webhook končnih točk na organizacijo.

Ustvari webhook

text

POST /webhooks

Telo zahteve

json

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

Field	Type	Required	Opis
`url`	string	Da	HTTPS URL končne točke za prejemanje webhook dostav
`events`	string[]	Da	Seznam tipov dogodkov za naročnino (ali `["*"]` za vse)
`description`	string	Ne	Berljiv opis za to končno točko

Odgovor (201 Ustvarjeno)

json

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

Pomembno: signingSecret se vrne samo ob prvem ustvarjanju webhooka. Varno ga shranite -- potrebovali ga boste za preverjanje dohodnih webhook podpisov. Ponovno ga ni mogoče pridobiti.

Zaščita pred SSRF

URL-ji webhookov morajo biti javno dostopne HTTPS končne točke. Naslednji so zavrnjeni:

Zasebni/notranji IP naslovi (10.x.x.x, 172.16-31.x.x, 192.168.x.x)
Localhost in povratni (loopback) naslovi
URL-ji brez HTTPS

Seznam webhookov

text

GET /webhooks

Odgovor

json

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

Posodobi webhook

text

PUT /webhooks/:id

Parametri poti

Name	Type	Required	Opis
`id`	string	Da	ID webhooka

Telo zahteve

json

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

Vsa polja so izbirna. Posodobljena so samo navedena polja.

Odgovor

Vrne posodobljen webhook objekt.

Izbriši webhook

text

DELETE /webhooks/:id

Parametri poti

Name	Type	Required	Opis
`id`	string	Da	ID webhooka

Odgovor

Vrne 204 No Content ob uspešnem brisanju.

Testiraj webhook

Pošljite testni dogodek za preverjanje, ali je vaša končna točka dosegljiva in pravilno obdeluje webhook dostave.

text

POST /webhooks/:id/test

Parametri poti

Name	Type	Required	Opis
`id`	string	Da	ID webhooka

Odgovor

json

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

Če testna dostava ne uspe:

json

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