Olaylar ve payload'lar

Bir olayı almak, verisinin scope’unu gerektirir

Abonelik oluşturmak write_webhooks gerektirir. Bir olayı almak ise taşıdığı verinin okuma scope’unu (yetkisini) gerektirir; bu, her teslimatta kurulumunuzun o anda sahip olduklarına göre denetlenir:

Olay ailesi	Almak için gereken scope
order.*	read_orders (write_orders bunu kapsar)
product.*	read_products
customer.*	read_customers
form.submitted	read_forms

Aşağıda kişisel veri olarak işaretlenen alanlar, kurulumunuz ayrıca read_customer_pii’ye sahip değilse gövdeden çıkarılır. Tüccar bir scope’u geri çekerse sonraki olay size teslim edilmez. Alamayacağınız bir olaya abone olmak, gereken scope’u adıyla belirten bir 400 ile reddedilir.

Katalog

Olay	Abone olunabilir	Bugün gönderiliyor
order.paid	evet	evet
order.shipped	evet	evet
order.cancelled	evet	evet
order.refunded	evet	evet
order.created	evet	hayır — abonelikte kabul edilir, henüz hiç yayımlanmadı
order.fulfilled	evet	hayır
product.created / product.updated / product.deleted	evet	hayır
customer.created / customer.updated	evet	hayır
form.submitted	evet	evet

Yalnızca evet olarak işaretlenen olayların üzerine inşa edin. Diğerleri ayrılmış adlardır: onlara şimdi abone olabilirsiniz ve platform onları yayımlamaya başladığında almaya başlarsınız — ama bugün hiçbir şey için onları beklemeyin.

Gövde

Zarf (envelope) yoktur: gövde olay nesnesinin kendisidir, camelCase JSON. Olay türü Ciqra-Event header’ında, olay id’si ise Ciqra-Event-Id’de taşınır.

order.*

{
  "orderId": "5b1e…",
  "orderNumber": "SEY-100482",
  "status": "Paid",
  "customerEmail": "[email protected]",
  "occurredAt": "2026-09-22T10:15:03.412+00:00"
}

Alan	Notlar
orderId	UUID.
orderNumber	Tüccarın ve alışverişçinin gördüğü numara.
status	Siparişin geçtiği durum: Paid, Shipped, Cancelled veya Refunded.
customerEmail	Kişisel veri — yalnızca read_customer_pii ile bulunur.
occurredAt	Geçişin kaydedildiği zaman.

Olay id’si {orderId}:{status} biçimindedir; dolayısıyla bir sipariş, durum başına en fazla bir olay üretir.

Gövde bilerek minimal tutulmuştur. Satır kalemleri, tutarlar veya adresler için sipariş API’si gerekir; o da henüz uygulamalara açık değildir — bkz. sınırlamalar.

form.submitted

{
  "formId": "…",
  "formName": "Contact",
  "submissionId": "…",
  "languageCode": "tr",
  "submittedAt": "2026-09-22T10:15:03+00:00",
  "values": { "name": "…", "email": "…", "message": "…" }
}

Alan	Notlar
values	Kişisel veri — yalnızca read_customer_pii ile bulunur. Tüccarın tanımladığı, formun kendi alan anahtarlarıyla anahtarlanır; alışverişçinin ne yazdıysa onu içerir.

Yalnızca read_forms ile bir formun gönderildiğini, hangisinin, ne zaman ve hangi dilde gönderildiğini öğrenirsiniz.