hikiehikieDeveloper Documentation
Eventler

Event kataloğu

Dinleyebileceğiniz tüm event tipleri, ne zaman tetiklendikleri ve ortak gövde yapısı.

Abonelik oluştururken bu listeden dilediklerinizi seçersiniz. Yalnızca seçtikleriniz gönderilir.

Tüm eventler

EventNe zamanAyrıntı
order.paidÖdeme başarıyla tamamlandıSipariş
order.updatedSiparişin kendi durumu COMPLETED, REFUNDED veya CANCELLED olduSipariş
order.shipmentUpdatedSiparişin kargo durumu değiştiSipariş
subscription.payment_failedAbonelik yenileme çekimi başarısız oldu (her denemede bir kez)Abonelik
subscription.cancelledAbonelik kapandı, bir daha yenilenmeyecekAbonelik
product.createdYeni ürün eklendiÜrün
product.updatedÜrün güncellendiÜrün
product.deletedÜrün silindiÜrün
license.createdBir üye için lisans anahtarı üretildiLisans
license.revokedSatıcı bir anahtarı iptal ettiLisans
license.restoredİptal edilmiş anahtar geri alındıLisans
test.pingPanelden "Test gönder"Test

license.* eventleri yalnızca Yazılım modülü kurulu mağazalarda üretilir. Bunlar lisansın geçerliliğini değil, kaydın değiştiğini bildirir — ayrıntı ve iade davranışı için Lisans eventleri.

Kaldırıldı: order.created, order.payment_failed, refund.requested, refund.updated ve product.out_of_stock artık yok ve seçilemez.

İstek gövdesi

Zarf yok. Gövde doğrudan event payload'ıdır; event tipi, teslimat kimliği, API sürümü ve hesap kimliği HTTP başlıklarında taşınır.

order.paid gövdesi
{
  "orderId": "17716204135268844HKS",
  "status": "COMPLETED",
  "storeSlug": "magazam",
  "totals": { "total": "249.90" }
}

Event tipini gövdeden değil başlıktan okuyun:

const eventType = req.get('Hikie-Event');   // "order.paid"
const webhookId = req.get('Hikie-Webhook-Id');
const occurredAt = req.get('Hikie-Occurred-At');
const payload = JSON.parse(rawBody);        // modelin kendisi
BaşlıkNe taşır
Hikie-EventEvent tipi — yukarıdaki tablodan biri
Hikie-Webhook-IdTeslimat kimliği; yeniden denemelerde değişmez. Tekrar kontrolünüzün anahtarı
Hikie-Account-IdMağaza hesabınızın kimliği. Tek endpoint birden fazla mağazaya hizmet ediyorsa ayırt etmek için
Hikie-Occurred-Atİşin gerçekten olduğu an (ISO 8601 UTC) — sıralama için bunu kullanın
Hikie-Api-VersionPayload şemasının sürümü (2026-09-04)
Hikie-Delivery-AttemptKaçıncı deneme olduğu

Tam liste: İstek başlıkları.

Gövde tüm yeniden denemelerde bayt bayt aynı kalır. Deneme sayısı ve zaman damgası gövdede değil başlıklarda olduğu için gövdeyi hash'leyip karşılaştırabilirsiniz.

Ortak kurallar

Her model aynı kuralları izler:

KuralAyrıntı
TutarlarDize, iki ondalıklı: "249.90". Asla JSON sayısı değil
Para birimiModelin kökünde currency alanı. Bugün TRY
Tarihlerdate önekli adlar (dateCreated, dateUpdated), ISO 8601 UTC
KimliklerModelin adını taşır: orderId, productId, subscriptionId. Asla çıplak id
Gruplamaİlişkili alanlar iç içe nesnelerde: totals, customerInfo, items, pricing, plan
Enum'larMağazanın kendi değerleri (COMPLETED, DIGITAL, out_of_stock) — event sayfalarına bakın

Alan kuralları

Sürüm politikası

Payload şemasının sürümü Hikie-Api-Version başlığında taşınır. Şu anki sürüm: 2026-09-04.

  • Kırıcı olmayan değişiklikler (yeni alan, yeni event tipi) sürümü artırmaz.
  • Kırıcı değişiklikler (alan kaldırma, tip değiştirme) yeni bir sürümle gelir; eski sürüm bir süre desteklenir.

Sürümü kontrol etmek isterseniz:

const surum = req.get('Hikie-Api-Version');
if (surum !== '2026-09-04') {
  console.warn(`[hikie] beklenmeyen API sürümü: ${surum}`);
}

Bu sayfada