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
}
}
| Alan | Tip | Zorunlu | Açıklama |
|---|---|---|---|
webhook_endpoint.url | string | evet | Bildirimin 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.events | array | evet | Gö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_active | boolean | hayır | false ise adres kapalı eklenir ve bildirim gönderilmez. Gönderilmezse true. |
SDK örnekleri
not
Örneklerdeki $client / client nesnesinin kurulumu: İstemciyi Kurmak.
- PHP
- Node.js
- Python
- Java
- cURL
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;
const { webhookEndpoint } = await client.createWebhookEndpoint({
url: 'https://magazam.com/odemehub/webhook',
events: ['order.paid', 'order.payment_refunded'],
});
webhookEndpoint.token;
from odemehub.enums import WebhookEvent
from odemehub.request import CreateWebhookEndpoint
webhook_endpoint = client.create_webhook_endpoint(CreateWebhookEndpoint(
url="https://magazam.com/odemehub/webhook",
events=[WebhookEvent.ORDER_PAID, WebhookEvent.ORDER_PAYMENT_REFUNDED], # ya da "order.paid" gibi metin
)).webhook_endpoint
webhook_endpoint.token
import com.odemehub.enums.WebhookEvent;
import com.odemehub.request.CreateWebhookEndpoint;
var webhookEndpoint = client.createWebhookEndpoint(CreateWebhookEndpoint.builder()
.url("https://magazam.com/odemehub/webhook")
.events(WebhookEvent.ORDER_PAID, WebhookEvent.ORDER_PAYMENT_REFUNDED) // ya da .events("order.paid", ...)
.build()).getWebhookEndpoint();
webhookEndpoint.getToken();
URI_PATH="/api/$ODEMEHUB_TEAM/gateway/create-webhook-endpoint"
BODY='{"webhook_endpoint":{"url":"https://magazam.com/odemehub/webhook","events":["order.paid"]}}'
TIMESTAMP=$(date +%s)
SIGNATURE=$(printf '%s\n%s\n%s\n%s' "$TIMESTAMP" "POST" "$URI_PATH" "$BODY" | openssl dgst -sha256 -hmac "$ODEMEHUB_API_SECRET" | sed 's/^.* //')
curl -X POST "https://sandbox.odemehub.com$URI_PATH" \
-H "Content-Type: application/json" \
-H "X-Api-Key: $ODEMEHUB_API_KEY" \
-H "X-Timestamp: $TIMESTAMP" \
-H "X-Signature: $SIGNATURE" \
--data-raw "$BODY"
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
| Alan | Tip | Açıklama |
|---|---|---|
token | string | null | Adresin token'ı (UUID); güncelleme ve silmede adres parametresi. Panelden eklenmiş eski adreslerde null olabilir; bunlar API'den güncellenemez ve silinemez. |
url | string | Bildirimin gönderildiği adres. |
events | array | Seçili olaylar. |
is_active | boolean | Adres açıksa true. |
created_at | string | Ekleniş anı, ISO 8601, UTC. |
HTTP durum kodları
| Kod | Durum |
|---|---|
200 | Adres eklendi. |
401 | API 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. |
422 | Doğrulama hatası. |
429 | İstek sınırı aşıldı. |
Hatalar
| Alan | Mesaj |
|---|---|
webhook_endpoint.events | En az bir olay seçin. |
webhook_endpoint.events.* | Bu olay çalışma alanınızda kullanılamıyor. |
webhook_endpoint.url | Bu adres zaten ekli; olayları onun üzerinden seçin. |
webhook_endpoint.url | Adres herkese açık bir adres olmalı. |