Webhooks valdymas

Valdykite savo webhook galinius taškus (endpoints), kad gautumėte realaus laiko įvykių pranešimus. Galite užregistruoti iki 10 webhook galinių taškų vienai organizacijai.

Sukurti webhook

text

POST /webhooks

Užklausos turinys

json

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

Laukas	Tipas	Privalomas	Aprašymas
`url`	string	Taip	HTTPS galinio taško URL webhook pristatymams gauti
`events`	string[]	Taip	Įvykių tipų masyvas, kuriuos norite prenumeruoti (arba `["*"]` visiems)
`description`	string	Ne	Žmogui suprantamas šio galinio taško aprašymas

Atsakymas (201 Created)

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

Svarbu: signingSecret grąžinamas tik kuriant webhook pirmą kartą. Saugokite jį saugiai -- jums jo reikės gaunamų webhook parašų patikrinimui. Jo negalima gauti pakartotinai.

SSRF apsauga

Webhook URL turi būti viešai pasiekiami HTTPS galiniai taškai. Šie atmetami:

Privatūs/vidiniai IP adresai (10.x.x.x, 172.16-31.x.x, 192.168.x.x)
Localhost ir loopback adresai
Ne-HTTPS URL

Webhooks sąrašas

text

GET /webhooks

Atsakymas

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

Atnaujinti webhook

text

PUT /webhooks/:id

Kelio parametrai

Pavadinimas	Tipas	Privalomas	Aprašymas
`id`	string	Taip	Webhook ID

Užklausos turinys

json

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

Visi laukai neprivalomi. Atnaujinami tik pateikti laukai.

Atsakymas

Grąžina atnaujintą webhook objektą.

Ištrinti webhook

text

DELETE /webhooks/:id

Kelio parametrai

Pavadinimas	Tipas	Privalomas	Aprašymas
`id`	string	Taip	Webhook ID

Atsakymas

Sėkmės atveju grąžina 204 No Content.

Testuoti webhook

Siųskite testinį įvykį, kad patikrintumėte, ar jūsų galinis taškas pasiekiamas ir teisingai apdoroja webhook pristatymus.

text

POST /webhooks/:id/test

Kelio parametrai

Pavadinimas	Tipas	Privalomas	Aprašymas
`id`	string	Taip	Webhook ID

Atsakymas

json

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

Jei testinis pristatymas nepavyko:

json

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