vellTRDocs

Webhook'lar

Uç noktalar kaydedin ve teslimatları inceleyin. Kvell, kademeli yeniden denemeler ve DLQ ile imzalı olay POST’ları gönderir.

6 endpoints
GET/v1/stores/{storeId}/webhooksCore

Bir mağaza için yapılandırılmış webhook uç noktalarını listeler.

JSONYanıt Örneği
{
  "items": [
    {
      "id": "whe_9a2e6b4d4e8a",
      "url": "https://merchant.example.com/kvell/webhook",
      "eventTypes": [
        "payment.captured",
        "payment.refunded"
      ],
      "active": true,
      "status": "active",
      "createdAt": "2026-04-13T10:00:00Z"
    }
  ]
}
POST/v1/stores/{storeId}/webhooksCore

Bir mağaza için webhook uç noktası kaydeder. İmzalama gizli anahtarı yalnızca bir kez döndürülür. Kvell, her teslimatı X-Kvell-Signature: sha256=<bu gizli anahtar kullanılarak ham gövde üzerinden hesaplanan hex HMAC-SHA256> olarak imzalar.

İstek Parametreleri

AdTürZorunluAçıklama
urlstringZorunluHTTPS URL to deliver events to
eventTypesarrayİsteğe BağlıEvent types to receive (e.g. ["payment.captured"])
JSONİstek Örneği
{
  "url": "https://merchant.example.com/kvell/webhook",
  "eventTypes": [
    "payment.captured",
    "payment.refunded",
    "payout.succeeded"
  ]
}
JSONYanıt Örneği
{
  "id": "whe_9a2e6b4d4e8a",
  "merchantId": "mrc_8a1b2c3d4e5f",
  "url": "https://merchant.example.com/kvell/webhook",
  "secret": "whsec_2b3c4d5e6f708192a3b4c5d6",
  "eventTypes": [
    "payment.captured",
    "payment.refunded",
    "payout.succeeded"
  ],
  "active": true,
  "status": "active",
  "createdAt": "2026-04-13T10:00:00Z"
}
PATCH/v1/stores/{storeId}/webhooks/{webhookId}Core

Bir webhook uç noktasını etkinleştirir veya devre dışı bırakır.

İstek Parametreleri

AdTürZorunluAçıklama
activebooleanİsteğe BağlıEnable/disable delivery
JSONİstek Örneği
{
  "active": false
}
JSONYanıt Örneği
{
  "id": "whe_9a2e6b4d4e8a",
  "url": "https://merchant.example.com/kvell/webhook",
  "active": false,
  "status": "active"
}
DELETE/v1/stores/{storeId}/webhooks/{webhookId}Core

Bir webhook uç noktasını kaldırır. 204 No Content döner.

JSONYanıt Örneği
{}
GET/v1/merchants/{id}/webhook-deliveriesRecommended

Üye işyeri genelindeki teslimat denemelerini, mağaza ve teslimat durumu filtreleriyle listeler.

İstek Parametreleri

AdTürZorunluAçıklama
storeIdstringİsteğe BağlıFilter by store
statusstringİsteğe Bağlıpending|in_progress|delivered|failed|exhausted
limitintegerİsteğe BağlıPage size
offsetintegerİsteğe BağlıOffset
JSONYanıt Örneği
{
  "items": [
    {
      "id": "whd_0f1a2b3c4d5e",
      "endpointId": "whe_9a2e6b4d4e8a",
      "eventType": "payment.captured",
      "status": "delivered",
      "attemptCount": 1,
      "lastResponseCode": 200,
      "createdAt": "2026-04-13T10:00:03Z"
    }
  ]
}
POST/v1/deliveries/{id}/resendRecommended

Bir webhook teslimatını manuel olarak yeniden kuyruğa alır (deneme sayısını sıfırlar).

JSONİstek Örneği
{}
JSONYanıt Örneği
{
  "deliveryId": "whd_0f1a2b3c4d5e",
  "status": "queued"
}

Kategori Özeti

Toplam Endpoint

6

Ana Domain

api.pay.kvell.group