Ana içeriğe geç

update-webhook-endpoint

POST /api/{team}/gateway/update-webhook-endpoint/{token}

Adresin URL'ini, olaylarını ya da açık/kapalı durumunu değiştirir; yalnızca gönderilen alanlar değişir. Kapalı adrese bildirim gönderilmez; kapatılmadan önce sıraya girmiş bildirimler de gitmez.

Yalnızca iş ortağının açtığı çalışma alanlarında çalışır; diğerleri 403 alır. Bkz. İş Ortakları.

Kimlik doğrulama​

Çalışma alanının anahtarıyla: X-Api-Key, X-Timestamp, X-Signature, Content-Type: application/json. Ayrıntılar: Kimlik Doğrulama ve İmza.

İstek​

{
"token": "3e7a1c9b-5d2f-4a8e-9c6b-0f1e2d3c4b5a",
"webhook_endpoint": {
"events": ["order.paid", "order.payment_refunded", "order.payment_cancelled"],
"is_active": false
}
}
AlanTipZorunluAçıklama
tokenstringevetAdresin token'ı. Adresteki token'la aynı olmalıdır.
webhook_endpointobjectevetDeğişecek alanlar.
webhook_endpoint.urlstringhayırYeni adres; kurallar create-webhook-endpoint ile aynı.
webhook_endpoint.eventsarrayhayırOlayların yeni listesi; gönderilirse öncekinin yerini alır, en az biri.
webhook_endpoint.is_activebooleanhayırfalse adresi kapatır, true açar.

SDK örnekleri​

not

Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.

use Gurmehub\Odemehub\Request\UpdateWebhookEndpoint;

$webhookEndpoint = $client->updateWebhookEndpoint(new UpdateWebhookEndpoint(
token: $webhookEndpointToken,
isActive: false,
))->webhookEndpoint;

$webhookEndpoint->isActive; // false

Yanıt​

result ve adresin güncel hâli (webhook_endpoint): Webhook adresi nesnesi.

HTTP durum kodları​

KodDurum
200Adres güncellendi.
401API anahtarı ya da imza geçersiz.
403Çalışma alanı işlem yapamıyor ya da bir iş ortağının açtığı çalışma alanı değil: Bu uç yalnızca iş ortağı çalışma alanlarına açıktır.
404Bu webhook adresi bulunamadı.
422Doğrulama hatası.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
tokenGövdedeki token adresteki token ile aynı olmalı.
webhook_endpoint.eventsEn az bir olay seçin.
webhook_endpoint.events.*Bu olay çalışma alanınızda kullanılamıyor.
webhook_endpoint.urlBu adres zaten ekli; olayları onun üzerinden seçin.