Webhook kezelés (Webhook Management)
Kezelje webhook végpontjait a valós idejű eseményértesítések fogadásához. Szervezetenként legfeljebb 10 webhook végpontot regisztrálhat.
Webhook létrehozása
POST /webhooks
Kérés törzs (Request Body)
{
"url": "https://yourapp.com/webhooks/vignetim",
"events": ["order.completed", "order.failed"],
"description": "Production order notifications"
}
| Mező | Típus | Kötelező | Leírás |
|---|---|---|---|
url | string | Igen | HTTPS végpont URL a webhook kézbesítések fogadásához |
events | string[] | Igen | Feliratkozandó eseménytípusok tömbje (vagy ["*"] az összeshez) |
description | string | Nem | Ember által olvasható leírás ehhez a végponthoz |
Válasz (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"
}
Fontos: A
signingSecretcsak a webhook első létrehozásakor kerül visszaadásra. Tárolja biztonságosan -- szüksége lesz rá a bejövő webhook aláírások ellenőrzéséhez. Nem kérhető le újra.
SSRF védelem
A webhook URL-eknek nyilvánosan elérhető HTTPS végpontoknak kell lenniük. A következők elutasításra kerülnek:
- Privát/belső IP-címek (10.x.x.x, 172.16-31.x.x, 192.168.x.x)
- Localhost és loopback címek
- Nem HTTPS URL-ek
Webhookok listázása
GET /webhooks
Válasz
{
"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 frissítése
PUT /webhooks/:id
Útvonal paraméterek (Path Parameters)
| Név | Típus | Kötelező | Leírás |
|---|---|---|---|
id | string | Igen | A webhook azonosítója |
Kérés törzs (Request Body)
{
"url": "https://yourapp.com/webhooks/vignetim-v2",
"events": ["*"],
"description": "Updated to receive all events"
}
Minden mező opcionális. Csak a megadott mezők kerülnek frissítésre.
Válasz
A frissített webhook objektumot adja vissza.
Webhook törlése
DELETE /webhooks/:id
Útvonal paraméterek (Path Parameters)
| Név | Típus | Kötelező | Leírás |
|---|---|---|---|
id | string | Igen | A webhook azonosítója |
Válasz
Sikeres esetben 204 No Content választ ad vissza.
Webhook tesztelése
Teszt esemény küldése annak ellenőrzéséhez, hogy a végpont elérhető és helyesen dolgozza fel a webhook kézbesítéseket.
POST /webhooks/:id/test
Útvonal paraméterek (Path Parameters)
| Név | Típus | Kötelező | Leírás |
|---|---|---|---|
id | string | Igen | A webhook azonosítója |
Válasz
{
"success": true,
"statusCode": 200,
"responseTime": 145,
"message": "Test webhook delivered successfully"
}
Ha a teszt kézbesítés sikertelen:
{
"success": false,
"statusCode": 500,
"responseTime": 10000,
"message": "Webhook endpoint returned non-2xx status code"
}