Skip to content

مرجع الويب هوك

يرسل تدبير ويب هوك موقّعاً لأحداث الأعمال المهمة. تُسجَّل محاولات التسليم وتُعاد بالتأخير التصاعدي وتُعطَّل بعد فشل متكرر.

الرؤوس

الرأسالوصف
X-Tadbeer-Eventنوع الحدث، مثلاً invoice.issued.
X-Tadbeer-Event-IDمعرّف الحدث الفريد.
X-Tadbeer-Signatureتوقيع sha256=<hmac> على جسم الطلب الخام.
X-Tadbeer-Delivery-Attemptعداد المحاولات (يبدأ من 1).

تحقّق من التوقيعات بسر التوقيع قبل تحليل الحمولة.

invoice.issued

json
{
  "id": "evt_01HXZ4W2E7MJ4T8X9Z",
  "type": "invoice.issued",
  "occurred_at": "2026-05-11T09:42:00Z",
  "business_id": "0f645d2e-1ef1-4d8c-95bf-27fd5f9426a2",
  "data": {
    "invoice_id": "a48a31a9-bdfd-44ce-8e58-12d7110f5d5f",
    "doc_no": "INV-000241",
    "customer_id": "cbff21b0-e133-4398-92c7-09e7bbfb18f1",
    "currency_code": "SAR",
    "total": "1250.00",
    "tax_total": "163.04",
    "compliance_status": "accepted"
  }
}

payment.received

json
{
  "id": "evt_01HXZ52J7AE6FG2PN8",
  "type": "payment.received",
  "occurred_at": "2026-05-11T10:03:22Z",
  "business_id": "0f645d2e-1ef1-4d8c-95bf-27fd5f9426a2",
  "data": {
    "payment_id": "7dd1b3cf-b0a5-4a57-9a9b-0da61d2f9032",
    "invoice_id": "a48a31a9-bdfd-44ce-8e58-12d7110f5d5f",
    "amount": "500.00",
    "currency_code": "SAR",
    "method": "bank_transfer"
  }
}

backup.completed

json
{
  "id": "evt_01HXZ5QV4PAEVARW0F",
  "type": "backup.completed",
  "occurred_at": "2026-05-11T10:18:40Z",
  "business_id": "0f645d2e-1ef1-4d8c-95bf-27fd5f9426a2",
  "data": {
    "backup_id": "2e7f98e2-2f47-4d49-9b47-0902709d0fb3",
    "device_id": "ios-warehouse-1",
    "size_bytes": 18423093,
    "checksum_sha256": "9c14f6f9b5b7cfe88bbd0df6f84b0d4f3a5e5d9a8e1fa1cbbd0f57d1d96a4db1"
  }
}

support.ticket_created

json
{
  "id": "evt_01HXZ6AB1JNR32Q4YA",
  "type": "support.ticket_created",
  "occurred_at": "2026-05-11T10:27:19Z",
  "business_id": "0f645d2e-1ef1-4d8c-95bf-27fd5f9426a2",
  "data": {
    "ticket_id": "d4eb6351-d6b3-47a4-ae30-3b7c4b69d20c",
    "priority": "high",
    "category": "technical",
    "status": "open"
  }
}

وثائق تدبير للمشغّلين والمطوّرين وشركاء التنفيذ.