Ana içeriğe geç

create-webhook-endpoint

POST /api/{team}/gateway/create-webhook-endpoint

Çalışma alanına bir webhook adresi ekler. Seçilen olaylar bu adrese, panelden eklenen adreslerdeki gibi gönderilir ve çalışma alanının gizli anahtarıyla imzalanır: Webhook. Eklenen adres yanıttaki token'la anılır.

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​

{
"webhook_endpoint": {
"url": "https://magazam.com/odemehub/webhook",
"events": ["order.paid", "order.payment_refunded"],
"is_active": true
}
}
AlanTipZorunluAçıklama
webhook_endpoint.urlstringevetBildirimin gönderileceği adres; https ile başlayan, herkese açık bir adres, en çok 2048 karakter. Bir adres çalışma alanına bir kez eklenir.
webhook_endpoint.eventsarrayevetGönderilecek olaylar, en az biri, her biri bir kez. Yalnızca çalışma alanında açık modüllerin olayları seçilebilir.
webhook_endpoint.is_activebooleanhayırfalse ise adres kapalı eklenir ve bildirim gönderilmez. Gönderilmezse true.

SDK örnekleri​

not

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

use Gurmehub\Odemehub\Enum\WebhookEvent;
use Gurmehub\Odemehub\Request\CreateWebhookEndpoint;

$webhookEndpoint = $client->createWebhookEndpoint(new CreateWebhookEndpoint(
url: 'https://magazam.com/odemehub/webhook',
events: [WebhookEvent::OrderPaid, WebhookEvent::OrderPaymentRefunded], // ya da 'order.paid' gibi metin
))->webhookEndpoint;

$webhookEndpoint->token;

Yanıt​

{
"result": { "successful": true, "message": null },
"webhook_endpoint": {
"token": "3e7a1c9b-5d2f-4a8e-9c6b-0f1e2d3c4b5a",
"url": "https://magazam.com/odemehub/webhook",
"events": ["order.paid", "order.payment_refunded"],
"is_active": true,
"created_at": "2026-11-05T09:40:00.000000Z"
}
}

Webhook adresi nesnesi​

AlanTipAçıklama
tokenstring | nullAdresin token'ı (UUID); güncelleme ve silmede adres parametresi. Panelden eklenmiş eski adreslerde null olabilir; bunlar API'den güncellenemez ve silinemez.
urlstringBildirimin gönderildiği adres.
eventsarraySeçili olaylar.
is_activebooleanAdres açıksa true.
created_atstringEkleniş anı, ISO 8601, UTC.

HTTP durum kodları​

KodDurum
200Adres eklendi.
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.
422Doğrulama hatası.
429İstek sınırı aşıldı.

Hatalar​

AlanMesaj
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.
webhook_endpoint.urlAdres herkese açık bir adres olmalı.