Olaylar ve Webhook
Webhook adresi oluştur
POST/v1/webhook_endpoints
Değişikliklerin sizin HTTPS adresinize imzalı olarak gönderilmesi için adres ekleyin.
- Gereken izin
Bearer anahtarı ve
webhooks:manage- Maliyet
1 puan (bağlantı başına 60 saniyede 600 puan)
- Tekrar anahtarı
Gerekir:
Idempotency-Keybaşlığı.
İstek
Temel adres: https://api.siparis.app/v1
Başlıklar
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
Idempotency-Key | metin · null olabilir | Evet | Zorunlu tekrar anahtarı; en çok 200 karakter. Yeni işte yeni değer; ağ tekrarında aynı gövde ve aynı değer. | "ilk-esitleme-20261016-001" |
Gövde (application/json)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
event_types | liste: metin (en çok 100 öğe) | Evet | Dinlenecek olay türleri; jokerler oluşturma anındaki izinli türlere sabitlenir. | |
url | metin (en çok 2000 karakter) | Evet | Genel internete açık, kullanıcı bilgisi içermeyen HTTPS webhook adresi; port 443. | "https://example.com/webhooks/siparis" |
grant | metin · null olabilir | Hayır | API bağlantısı kimliği (grt_ ve 32 küçük onaltılık karakter). | "grt_1234567890abcdef1234567890abcdef" |
schema_version | sabit 1 | Hayır | Olay yükünün şema sürümü. | 1 |
store | metin · null olabilir | Hayır | Marka kimliği (sto_ ve 32 küçük onaltılık karakter). | "sto_1234567890abcdef1234567890abcdef" |
Örnek istek
curl --fail-with-body --silent --show-error --request POST \
"${SIPARIS_API_URL:-https://api.siparis.app/v1}/webhook_endpoints" \
-H "Authorization: Bearer $SIPARIS_API_KEY" \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: ornek-post-v1-webhook-endpoints-001' \
--data-binary @- <<'JSON'
{
"event_types": [
"order.created"
],
"url": "https://example.com/webhooks/siparis"
}
JSONimport json
import os
from urllib.request import Request, build_opener, HTTPRedirectHandler
from urllib.error import HTTPError
# İmzalı indirme hedefine Bearer taşımamak için yönlendirme kendiliğinden izlenmez.
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
base = os.environ.get("SIPARIS_API_URL", "https://api.siparis.app/v1")
headers = {
"Authorization": "Bearer " + os.environ["SIPARIS_API_KEY"],
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-webhook-endpoints-001",
}
request = Request(base + "/webhook_endpoints", headers=headers, method="POST",
data="{\"event_types\":[\"order.created\"],\"url\":\"https://example.com/webhooks/siparis\"}".encode("utf-8"))
try:
with build_opener(NoRedirect).open(request, timeout=30) as response:
print(response.read().decode("utf-8"))
except HTTPError as error:
print(error.code, error.read().decode("utf-8"))
raise
// Node.js 22+; anahtar yalnız sunucunun ortam değişkenindedir.
const base = process.env.SIPARIS_API_URL ?? "https://api.siparis.app/v1";
if (!process.env.SIPARIS_API_KEY) throw new Error("SIPARIS_API_KEY gerekli");
const response = await fetch(base + "/webhook_endpoints", {
method: "POST",
headers: {
"Authorization": `Bearer ${process.env.SIPARIS_API_KEY}`,
"Content-Type": "application/json",
"Idempotency-Key": "ornek-post-v1-webhook-endpoints-001",
},
redirect: "manual", // 307 hedefini Bearer olmadan ayrı istekte okuyun.
signal: AbortSignal.timeout(30_000),
body: JSON.stringify({
"event_types": [
"order.created"
],
"url": "https://example.com/webhooks/siparis"
}),
});
const text = await response.text();
if (!response.ok) throw new Error(`${response.status}: ${text}`);
console.log(text);
Kimlik içeren yollarda örnek kimliği kendi liste yanıtınızdan alın. SIPARIS_API_KEY sunucu ortamında tanımlı olmalı; yerelde SIPARIS_API_URL ile /v1 içeren adresi değiştirin. Üretimde tekrar kurallarını uygulayın.
Yanıt
201 İstek başarıyla tamamlandı.
İçerik türü: application/json
{
"endpoint": {
"created_at": "2026-10-16T09:00:00Z",
"event_types": [
"order.created"
],
"grant": "grt_1234567890abcdef1234567890abcdef",
"id": "whe_1234567890abcdef1234567890abcdef",
"last_attempt_at": null,
"last_error": null,
"last_success_at": null,
"previous_secret_until": null,
"schema_version": 1,
"status": "pending_test",
"store": "sto_1234567890abcdef1234567890abcdef",
"store_name": "Örnek Marka",
"url": "https://example.com/webhooks/siparis"
},
"secret": "whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA="
}Yanıt alanları (15)
| Alan | Tür | Zorunlu | Açıklama | Örnek |
|---|---|---|---|---|
endpoint | nesne | Evet | Webhook adresinin güncel durumu. | |
created_at | tarih-saat | Evet | Oluşturulma zamanı; RFC 3339 UTC. | "2026-10-16T09:00:00Z" |
event_types | liste: metin | Evet | Dinlenecek olay türleri; jokerler oluşturma anındaki izinli türlere sabitlenir. | |
grant | metin | Evet | API bağlantısı kimliği (grt_ ve 32 küçük onaltılık karakter). | "grt_1234567890abcdef1234567890abcdef" |
id | metin | Evet | Kaynağın dış kimliği; whe_ ve 32 küçük onaltılık karakter. İç sayısal kimlik kullanılmaz. | "whe_1234567890abcdef1234567890abcdef" |
last_attempt_at | tarih-saat · null olabilir | Evet | Son teslim denemesi zamanı; RFC 3339 UTC. Değer yoksa null. | null |
last_error | metin · null olabilir | Evet | Son teslim hatasının kararlı kodu; hata yoksa null. | null |
last_success_at | tarih-saat · null olabilir | Evet | Son başarılı teslim zamanı; RFC 3339 UTC. Değer yoksa null. | null |
previous_secret_until | tarih-saat · null olabilir | Evet | Önceki webhook sırrının geçerlilik sonu zamanı; RFC 3339 UTC. Değer yoksa null. | null |
schema_version | tam sayı | Evet | Olay yükünün şema sürümü. | 1 |
status | metin (seçenekler: pending_test, active, disabled_auto, disabled_remote, closed) | Evet | pending_test: deneme bekliyor; active: açık; disabled_auto: hatalarla durdu; disabled_remote: alıcı 410 verdi; closed: kapalı. | "pending_test" |
store | metin · null olabilir | Evet | Marka kimliği (sto_ ve 32 küçük onaltılık karakter). | "sto_1234567890abcdef1234567890abcdef" |
store_name | metin · null olabilir | Evet | Webhook adresinin bağlı olduğu markanın görünen adı. | "Örnek Marka" |
url | metin | Evet | Genel internete açık, kullanıcı bilgisi içermeyen HTTPS webhook adresi; port 443. | "https://example.com/webhooks/siparis" |
secret | metin · null olabilir | Hayır | Yalnız oluşturma/döndürmenin ilk yanıtında bir kez gösterilen whsec_ imza sırrı; Idempotent-Replayed yanıtında alan yoktur. Güvenli ortam değişkeninde saklayın. | "whsec_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=" |
Hatalar
| HTTP | code | Anlamı | Nasıl düzelir? |
|---|---|---|---|
| 403 | grant_mismatch | Başka API bağlantısının webhook adresi istenmiş. | Yalnız kullandığınız Bearer anahtarının bağlantısını yönetin; grant alanını atlayabilirsiniz. |
| 422 | invalid_grant | Webhook yönetimi açık bağlantı bulunamadı. | Açık, webhooks:manage kapsamlı bağlantı kullanın. |
| 422 | invalid_webhook_url | Webhook adresi kabul edilmiyor. | Genel internete çözülen, kullanıcı bilgisi içermeyen HTTPS/443 adresi kullanın. |
| 422 | invalid_store | Marka bağlantının yetkisinde değil veya kapalı. | /me stores listesindeki bir markayı seçin. |
| 422 | invalid_event_types | Olay türü geçersiz veya izinli tür yok. | Olay kataloğundan tür seçin ve kaynak kapsamını açın. |
Ortak hatalar (anahtar, izin, istek biçimi, hız sınırı, tekrar anahtarı) her uçta aynıdır: Hata kodları › Ortak hatalar.