Web kancası ucuna deneme olayı gönder

POST /v1/webhook-endpoints/{endpoint_id}:test · izin webhook-endpoints:write · bütün planlar

Uca seçilen türde (varsayılan user.created) imzalı tek bir sentetik olay gönderir ve sonucu döndürür. Olay data.test = true taşır ve gerçek bir teslim gibi ucun güncel sırrıyla imzalanır; imza doğrulamanızı böyle sınayabilirsiniz. Teslim kaydı açılmaz, alıcının yanıt gövdesi döndürülmez. Her uç dakikada 10 deneme kabul eder.

İstek

Alan Tür Zorunlu Açıklama
endpoint_id yol evet Web kancası ucu kimliği (whe_…).
event_type string hayır Gönderilecek olay kataloğu türü; varsayılan user.created. Gövde isteğe bağlıdır.
Idempotency-Key başlık hayır Aynı anahtarla tekrarlanan istekte sonucu yeniden oynatır. 
{
  "event_type": "user.updated"
}

Yanıt

Sonuçla 200 OK. Başarısız teslim de 200 döner: succeeded false olur, error_class nedenini söyler (timeout, tls, dns, egress_blocked, http_status, connection).

{
  "succeeded": true,
  "http_status": 204,
  "error_class": null,
  "latency_ms": 87,
  "event_id": "evt_01k8a3m7s9v1w3x5y7z9b2c4d6"
}

Hatalar

HTTP code Ne zaman
400 unknown_field Gövdede yukarıda olmayan bir alan var.
404 not_found Bu ortamda böyle bir uç yok.
409 conflict Uç enabled değil.
422 validation_failed /event_type unknown_event_type: katalogda olmayan tür.
429 rate_limited Bu uç için dakikada 10 deneme aşıldı; Retry-After süresinden sonra yeniden deneyin.
401 unauthenticated Kimlik bilgisi yok, geçersiz ya da iptal edilmiş.
403 insufficient_permissions Kimlik bilgisinde webhook-endpoints:write yok.
503 service_unavailable Web kancası yönetimi geçici olarak kullanılamıyor; Retry-After süresinden sonra yeniden deneyin.

Örnek

curl -X POST https://api.eu.keenauth.com/v1/webhook-endpoints/whe_01k8a3m5q7t9v1w3x5y7z9b2c4:test \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"event_type":"user.updated"}'

CLI: keenauth webhook-endpoints test whe_01k8a3m5q7t9v1w3x5y7z9b2c4 --event-type user.updated