الويب هوك

عرض بصيغة Markdown

استقبل الأحداث (رسائل جديدة، تحديثات التسليم) على خادمك مباشرة.

نقاط الواجهة

getعرض أنواع الأحداث/event_types
postإعادة الإرسال الآن/webhook_deliveries/{id}/retry
getعرض نقاط استقبال الويب هوك/webhook_endpoints
postإضافة نقطة استقبال ويب هوك/webhook_endpoints
getجلب نقطة استقبال/webhook_endpoints/{id}
patchتعديل نقطة استقبال/webhook_endpoints/{id}
DELحذف نقطة استقبال/webhook_endpoints/{id}
getعرض عمليات الإرسال/webhook_endpoints/{id}/deliveries
postتدوير سر التوقيع/webhook_endpoints/{id}/rotate_secret
postإرسال حدث تجريبي/webhook_endpoints/{id}/test

عرض أنواع الأحداث

gethttps://api.saei.automize.sa/v1/event_types

الصلاحية: webhooks:read
يعمل في وضع الاختبار

كل الأحداث التي يمكنك الاشتراك فيها.

حقول الاستجابة200· أنواع الأحداث.

object"list"مطلوب
dataarray<EventType>مطلوب
الحقول الفرعية (4)
- object"event_type"مطلوب
- typestringمطلوب
- object_typestringاختياري
- descriptionstringمطلوب
has_morebooleanمطلوب
next_cursorstring | nullمطلوب

جرّبها

curl -X GET https://api.saei.automize.sa/v1/event_types \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

أنواع الأحداث.

{
  "object": "list",
  "data": [
    {
      "object": "event_type",
      "type": "message.delivered",
      "object_type": "string",
      "description": "string"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

إعادة الإرسال الآن

posthttps://api.saei.automize.sa/v1/webhook_deliveries/{id}/retry

الصلاحية: webhooks:write
يعمل في وضع الاختبار

يرسل نفس الحدث مرة أخرى (نفس webhook-id وتوقيع جديد)، مثلًا بعد إصلاح خادمك.

معاملات المسار

idstringمطلوب
معرّف العنصر.

حقول الاستجابة202· أُضيف لقائمة الإرسال.

idstringمطلوب
object"webhook_delivery"مطلوب
livemodebooleanمطلوب
webhook_endpoint_idstringمطلوب
event_idstringمطلوب
event_typestringمطلوب
statusstringمطلوب
failed ستُعاد محاولته في next_attempt_at، وdead لن تُعاد محاولته.
إحدى القيمpendingsucceededfaileddead
attemptsintegerمطلوب
http_statusinteger | nullاختياري
duration_msinteger | nullاختياري
response_snippetstring | nullاختياري
last_errorstring | nullاختياري
next_attempt_atstring | nullاختياري
delivered_atstring | nullاختياري
created_atstring | nullاختياري
payloadobjectاختياري
جسم كل طلب ويب هوك. data.object هو نفس المورد الذي تُرجعه الواجهة (مثل message).
الحقول الفرعية (8)
- idstringمطلوب
  معرّف الحدث، ويُرسل أيضًا في ترويسة webhook-id. ثابت في كل إعادة محاولة، فاستخدمه لتجاهل التكرار.
- object"event"مطلوب
- typestringمطلوب
- versionstringمطلوب
  إصدار الحمولة. داخل الإصدار الواحد تُضاف الحقول فقط ولا تُحذف.
- created_atstringمطلوب
- livemodebooleanمطلوب
- workspace_idstringمطلوب
- dataobjectمطلوب
  الحقول الفرعية (2)
  objectobjectمطلوب
  previous_attributesobjectاختياري
  القيم التي تغيّرت كما كانت قبل التغيير، عند توفرها.

الأخطاء المحتملة1

404resource_missingغير موجود

جرّبها

curl -X POST https://api.saei.automize.sa/v1/webhook_deliveries/del_01j9x3k2m4n5p6q7r8s9t0v1w2/retry \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

أُضيف لقائمة الإرسال.

{
  "id": "del_01j9x3k2m4n5p6q7r8s9t0v1w2",
  "object": "webhook_delivery",
  "livemode": false,
  "webhook_endpoint_id": "string",
  "event_id": "string",
  "event_type": "string",
  "status": "pending",
  "attempts": 0,
  "http_status": 0,
  "duration_ms": 0,
  "response_snippet": "string",
  "last_error": "string",
  "next_attempt_at": "2026-10-01T09:30:00Z",
  "delivered_at": "2026-10-01T09:30:00Z",
  "created_at": "2026-10-01T09:30:00Z",
  "payload": {
    "id": "evt_01j9x3k2m4n5p6q7r8s9t0v1w2",
    "object": "event",
    "type": "message.delivered",
    "version": "2",
    "created_at": "2026-10-01T09:30:00Z",
    "livemode": false,
    "workspace_id": "ws_12",
    "data": {
      "object": {},
      "previous_attributes": {}
    }
  }
}

عرض نقاط استقبال الويب هوك

gethttps://api.saei.automize.sa/v1/webhook_endpoints

الصلاحية: webhooks:read
يعمل في وضع الاختبار

النقاط التابعة لوضع المفتاح (مفاتيح التشغيل ترى النقاط الحية، ومفاتيح الاختبار ترى نقاط الاختبار).

حقول الاستجابة200· نقاط الاستقبال.

object"list"مطلوب
dataarray<WebhookEndpoint>مطلوب
الحقول الفرعية (12)
- idstringمطلوب
- object"webhook_endpoint"مطلوب
- livemodebooleanمطلوب
  نقاط الاستقبال الحية تستقبل الأحداث الحية، ونقاط الاختبار تستقبل أحداث وضع الاختبار. لا تجتمعان أبدًا.
- urlstringمطلوب
- descriptionstring | nullاختياري
- enabled_eventsarray<string>مطلوب
  أنواع الأحداث المطلوب إرسالها، أو مجموعة كاملة مثل contact.*، أو ["*"] لكل الأحداث.
- statusstringمطلوب
  auto_disabled بعد 3 أيام من فشل التسليم أو عند الرد بـ 410 Gone.
  إحدى القيمenableddisabledauto_disabled
- disabled_reasonstring | nullاختياري
- secret_previewstringاختياري
- secretstringاختياري
  سر التوقيع (whsec_…). يُعاد فقط عند إنشاء النقطة أو تدوير سرّها. احفظه الآن.
- created_atstring | nullمطلوب
- updated_atstring | nullاختياري
has_morebooleanمطلوب
next_cursorstring | nullمطلوب

الأخطاء المحتملة1

429rate_limitedطلبات كثيرة

جرّبها

curl -X GET https://api.saei.automize.sa/v1/webhook_endpoints \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

نقاط الاستقبال.

{
  "object": "list",
  "data": [
    {
      "id": "we_01j9x3k2m4n5p6q7r8s9t0v1w2",
      "object": "webhook_endpoint",
      "livemode": false,
      "url": "string",
      "description": "string",
      "enabled_events": [
        "string"
      ],
      "status": "enabled",
      "disabled_reason": "string",
      "secret_preview": "string",
      "secret": "string",
      "created_at": "2026-10-01T09:30:00Z",
      "updated_at": "2026-10-01T09:30:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

إضافة نقطة استقبال ويب هوك

posthttps://api.saei.automize.sa/v1/webhook_endpoints

الصلاحية: webhooks:write
يعمل في وضع الاختبار
يقبل Idempotency-Key

سنرسل كل حدث مشترك فيه إلى url بطلب POST بصيغة JSON، موقّعًا بمعيار Standard Webhooks. تتضمن الاستجابة سر التوقيع secret مرة واحدة فقط: احفظه للتحقق من التواقيع.

في بيئة التشغيل يجب أن يبدأ الرابط بـ https:// وأن يكون متاحًا للعموم. حتى 10 نقاط لكل مساحة عمل.

يحمل الحدث البيانات نفسها التي تُرجعها نقطة القراءة الخاصة به، لذلك تحتاج كل عائلة أحداث صلاحية القراءة نفسها: message.* تحتاج messages:read، وcontact.* تحتاج contacts:read، وconversation.* تحتاج conversations:read، وcampaign.* تحتاج campaigns:read، وflow.* تحتاج flows:read، وtemplate.* تحتاج templates:read. أما ["*"] فتحتاجها كلها. ويسري الفحص نفسه عند تغيير رابط نقطة الاستقبال أو أحداثها.

الترويسات

Idempotency-Keystringاختياري
أي نص فريد (يُفضّل UUID). إعادة الطلب بنفس المفتاح ونفس الجسم تُرجع الاستجابة الأولى بدل التنفيذ مرتين. يُحفظ لمدة 24 ساعة.

جسم الطلب

urlstringمطلوب
الرابط الذي تُرسل إليه الأحداث.
enabled_eventsarray<string>مطلوب
أنواع الأحداث من GET /v1/event_types، أو مجموعة كاملة مثل contact.*، أو ["*"] لكل الأحداث.
descriptionstringاختياري

حقول الاستجابة201· تم الإنشاء. يظهر `secret` الآن فقط.

idstringمطلوب
object"webhook_endpoint"مطلوب
livemodebooleanمطلوب
نقاط الاستقبال الحية تستقبل الأحداث الحية، ونقاط الاختبار تستقبل أحداث وضع الاختبار. لا تجتمعان أبدًا.
urlstringمطلوب
descriptionstring | nullاختياري
enabled_eventsarray<string>مطلوب
أنواع الأحداث المطلوب إرسالها، أو مجموعة كاملة مثل contact.*، أو ["*"] لكل الأحداث.
statusstringمطلوب
auto_disabled بعد 3 أيام من فشل التسليم أو عند الرد بـ 410 Gone.
إحدى القيمenableddisabledauto_disabled
disabled_reasonstring | nullاختياري
secret_previewstringاختياري
secretstringاختياري
سر التوقيع (whsec_…). يُعاد فقط عند إنشاء النقطة أو تدوير سرّها. احفظه الآن.
created_atstring | nullمطلوب
updated_atstring | nullاختياري

الأخطاء المحتملة6

403insufficient_scopeصلاحية ناقصة
422parameter_missingحقل مفقود
422parameter_invalidحقل غير صالح
422webhook_url_invalidرابط الويب هوك غير مقبول
422webhook_endpoint_limitنقاط استقبال كثيرة
429rate_limitedطلبات كثيرة

جرّبها

curl -X POST https://api.saei.automize.sa/v1/webhook_endpoints \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhooks/whatsapp",
  "enabled_events": [
    "message.received",
    "message.delivered",
    "message.read",
    "message.failed"
  ],
  "description": "Order system"
}'

الاستجابة

تم الإنشاء. يظهر `secret` الآن فقط.

{
  "id": "we_01j9x3k2m4n5p6q7r8s9t0v1w2",
  "object": "webhook_endpoint",
  "livemode": true,
  "url": "https://example.com/webhooks/whatsapp",
  "description": "Order system",
  "enabled_events": [
    "message.received",
    "message.delivered",
    "message.read",
    "message.failed"
  ],
  "status": "enabled",
  "disabled_reason": null,
  "secret_preview": "whsec_…K3x=",
  "secret": "whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw/kNEBw0UXK3x=",
  "created_at": "2026-10-01T09:30:00Z",
  "updated_at": "2026-10-01T09:30:00Z"
}

جلب نقطة استقبال

gethttps://api.saei.automize.sa/v1/webhook_endpoints/{id}

الصلاحية: webhooks:read
يعمل في وضع الاختبار

معاملات المسار

idstringمطلوب
معرّف العنصر.

حقول الاستجابة200· نقطة الاستقبال.

idstringمطلوب
object"webhook_endpoint"مطلوب
livemodebooleanمطلوب
نقاط الاستقبال الحية تستقبل الأحداث الحية، ونقاط الاختبار تستقبل أحداث وضع الاختبار. لا تجتمعان أبدًا.
urlstringمطلوب
descriptionstring | nullاختياري
enabled_eventsarray<string>مطلوب
أنواع الأحداث المطلوب إرسالها، أو مجموعة كاملة مثل contact.*، أو ["*"] لكل الأحداث.
statusstringمطلوب
auto_disabled بعد 3 أيام من فشل التسليم أو عند الرد بـ 410 Gone.
إحدى القيمenableddisabledauto_disabled
disabled_reasonstring | nullاختياري
secret_previewstringاختياري
secretstringاختياري
سر التوقيع (whsec_…). يُعاد فقط عند إنشاء النقطة أو تدوير سرّها. احفظه الآن.
created_atstring | nullمطلوب
updated_atstring | nullاختياري

الأخطاء المحتملة1

404resource_missingغير موجود

جرّبها

curl -X GET https://api.saei.automize.sa/v1/webhook_endpoints/we_01j9x3k2m4n5p6q7r8s9t0v1w2 \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

نقطة الاستقبال.

{
  "id": "we_01j9x3k2m4n5p6q7r8s9t0v1w2",
  "object": "webhook_endpoint",
  "livemode": false,
  "url": "string",
  "description": "string",
  "enabled_events": [
    "string"
  ],
  "status": "enabled",
  "disabled_reason": "string",
  "secret_preview": "string",
  "secret": "string",
  "created_at": "2026-10-01T09:30:00Z",
  "updated_at": "2026-10-01T09:30:00Z"
}

تعديل نقطة استقبال

patchhttps://api.saei.automize.sa/v1/webhook_endpoints/{id}

الصلاحية: webhooks:write
يعمل في وضع الاختبار

غيّر الرابط أو الأحداث، أو أوقفها مؤقتًا بـ "disabled": true. إعادة التفعيل تصفّر عدّاد الإخفاقات.

معاملات المسار

idstringمطلوب
معرّف العنصر.

جسم الطلب

urlstringاختياري
enabled_eventsarray<string>اختياري
descriptionstring | nullاختياري
disabledbooleanاختياري

حقول الاستجابة200· نقطة الاستقبال بعد التعديل.

idstringمطلوب
object"webhook_endpoint"مطلوب
livemodebooleanمطلوب
نقاط الاستقبال الحية تستقبل الأحداث الحية، ونقاط الاختبار تستقبل أحداث وضع الاختبار. لا تجتمعان أبدًا.
urlstringمطلوب
descriptionstring | nullاختياري
enabled_eventsarray<string>مطلوب
أنواع الأحداث المطلوب إرسالها، أو مجموعة كاملة مثل contact.*، أو ["*"] لكل الأحداث.
statusstringمطلوب
auto_disabled بعد 3 أيام من فشل التسليم أو عند الرد بـ 410 Gone.
إحدى القيمenableddisabledauto_disabled
disabled_reasonstring | nullاختياري
secret_previewstringاختياري
secretstringاختياري
سر التوقيع (whsec_…). يُعاد فقط عند إنشاء النقطة أو تدوير سرّها. احفظه الآن.
created_atstring | nullمطلوب
updated_atstring | nullاختياري

الأخطاء المحتملة4

403insufficient_scopeصلاحية ناقصة
422parameter_invalidحقل غير صالح
404resource_missingغير موجود
422webhook_url_invalidرابط الويب هوك غير مقبول

جرّبها

curl -X PATCH https://api.saei.automize.sa/v1/webhook_endpoints/we_01j9x3k2m4n5p6q7r8s9t0v1w2 \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled_events": [
    "*"
  ]
}'

الاستجابة

نقطة الاستقبال بعد التعديل.

{
  "id": "we_01j9x3k2m4n5p6q7r8s9t0v1w2",
  "object": "webhook_endpoint",
  "livemode": false,
  "url": "string",
  "description": "string",
  "enabled_events": [
    "string"
  ],
  "status": "enabled",
  "disabled_reason": "string",
  "secret_preview": "string",
  "secret": "string",
  "created_at": "2026-10-01T09:30:00Z",
  "updated_at": "2026-10-01T09:30:00Z"
}

حذف نقطة استقبال

deletehttps://api.saei.automize.sa/v1/webhook_endpoints/{id}

الصلاحية: webhooks:write
يعمل في وضع الاختبار

يوقف كل الإرسال إليها، بما فيه إعادة المحاولات المعلّقة.

معاملات المسار

idstringمطلوب
معرّف العنصر.

حقول الاستجابة200· تم الحذف.

idstringمطلوب
object"webhook_endpoint"مطلوب
deletedtrueمطلوب

الأخطاء المحتملة1

404resource_missingغير موجود

جرّبها

curl -X DELETE https://api.saei.automize.sa/v1/webhook_endpoints/we_01j9x3k2m4n5p6q7r8s9t0v1w2 \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

تم الحذف.

{
  "id": "string",
  "object": "webhook_endpoint",
  "deleted": true
}

عرض عمليات الإرسال

gethttps://api.saei.automize.sa/v1/webhook_endpoints/{id}/deliveries

الصلاحية: webhooks:read
يعمل في وضع الاختبار

كل محاولة لإرسال حدث إلى هذه النقطة، الأحدث أولًا، مع رمز HTTP الذي أجاب به خادمك.

معاملات المسار

idstringمطلوب
معرّف العنصر.

معاملات الاستعلام

limitintegerاختياري
عدد العناصر المطلوبة، من 1 إلى 100.
cursorstringاختياري
قيمة next_cursor من الصفحة السابقة.
statusstringاختياري
فقط عمليات الإرسال في هذه الحالة.
إحدى القيمpendingsucceededfaileddead

حقول الاستجابة200· صفحة من عمليات الإرسال.

object"list"مطلوب
dataarray<WebhookDelivery>مطلوب
الحقول الفرعية (16)
- idstringمطلوب
- object"webhook_delivery"مطلوب
- livemodebooleanمطلوب
- webhook_endpoint_idstringمطلوب
- event_idstringمطلوب
- event_typestringمطلوب
- statusstringمطلوب
  failed ستُعاد محاولته في next_attempt_at، وdead لن تُعاد محاولته.
  إحدى القيمpendingsucceededfaileddead
- attemptsintegerمطلوب
- http_statusinteger | nullاختياري
- duration_msinteger | nullاختياري
- response_snippetstring | nullاختياري
- last_errorstring | nullاختياري
- next_attempt_atstring | nullاختياري
- delivered_atstring | nullاختياري
- created_atstring | nullاختياري
- payloadobjectاختياري
  جسم كل طلب ويب هوك. data.object هو نفس المورد الذي تُرجعه الواجهة (مثل message).
  الحقول الفرعية (8)
  idstringمطلوب
  معرّف الحدث، ويُرسل أيضًا في ترويسة webhook-id. ثابت في كل إعادة محاولة، فاستخدمه لتجاهل التكرار.
  object"event"مطلوب
  typestringمطلوب
  versionstringمطلوب
  إصدار الحمولة. داخل الإصدار الواحد تُضاف الحقول فقط ولا تُحذف.
  created_atstringمطلوب
  livemodebooleanمطلوب
  workspace_idstringمطلوب
  dataobjectمطلوب
  الحقول الفرعية (2)
  objectobjectمطلوب
  previous_attributesobjectاختياري
  القيم التي تغيّرت كما كانت قبل التغيير، عند توفرها.
has_morebooleanمطلوب
next_cursorstring | nullمطلوب

الأخطاء المحتملة1

404resource_missingغير موجود

جرّبها

curl -X GET https://api.saei.automize.sa/v1/webhook_endpoints/we_01j9x3k2m4n5p6q7r8s9t0v1w2/deliveries \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

صفحة من عمليات الإرسال.

{
  "object": "list",
  "data": [
    {
      "id": "del_01j9x3k2m4n5p6q7r8s9t0v1w2",
      "object": "webhook_delivery",
      "livemode": false,
      "webhook_endpoint_id": "string",
      "event_id": "string",
      "event_type": "string",
      "status": "pending",
      "attempts": 0,
      "http_status": 0,
      "duration_ms": 0,
      "response_snippet": "string",
      "last_error": "string",
      "next_attempt_at": "2026-10-01T09:30:00Z",
      "delivered_at": "2026-10-01T09:30:00Z",
      "created_at": "2026-10-01T09:30:00Z",
      "payload": {
        "id": "evt_01j9x3k2m4n5p6q7r8s9t0v1w2",
        "object": "event",
        "type": "message.delivered",
        "version": "2",
        "created_at": "2026-10-01T09:30:00Z",
        "livemode": false,
        "workspace_id": "ws_12",
        "data": {
          "object": {},
          "previous_attributes": {}
        }
      }
    }
  ],
  "has_more": false,
  "next_cursor": "string"
}

تدوير سر التوقيع

posthttps://api.saei.automize.sa/v1/webhook_endpoints/{id}/rotate_secret

الصلاحية: webhooks:write
يعمل في وضع الاختبار

يُرجع secret جديدًا. لمدة 24 ساعة يُوقَّع كل حدث بالسر القديم والجديد معًا، لتنشر السر الجديد دون أن يفوتك أي حدث.

معاملات المسار

idstringمطلوب
معرّف العنصر.

حقول الاستجابة200· نقطة الاستقبال مع سرّها الجديد.

idstringمطلوب
object"webhook_endpoint"مطلوب
livemodebooleanمطلوب
نقاط الاستقبال الحية تستقبل الأحداث الحية، ونقاط الاختبار تستقبل أحداث وضع الاختبار. لا تجتمعان أبدًا.
urlstringمطلوب
descriptionstring | nullاختياري
enabled_eventsarray<string>مطلوب
أنواع الأحداث المطلوب إرسالها، أو مجموعة كاملة مثل contact.*، أو ["*"] لكل الأحداث.
statusstringمطلوب
auto_disabled بعد 3 أيام من فشل التسليم أو عند الرد بـ 410 Gone.
إحدى القيمenableddisabledauto_disabled
disabled_reasonstring | nullاختياري
secret_previewstringاختياري
secretstringاختياري
سر التوقيع (whsec_…). يُعاد فقط عند إنشاء النقطة أو تدوير سرّها. احفظه الآن.
created_atstring | nullمطلوب
updated_atstring | nullاختياري

الأخطاء المحتملة1

404resource_missingغير موجود

جرّبها

curl -X POST https://api.saei.automize.sa/v1/webhook_endpoints/we_01j9x3k2m4n5p6q7r8s9t0v1w2/rotate_secret \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

نقطة الاستقبال مع سرّها الجديد.

{
  "id": "we_01j9x3k2m4n5p6q7r8s9t0v1w2",
  "object": "webhook_endpoint",
  "livemode": false,
  "url": "string",
  "description": "string",
  "enabled_events": [
    "string"
  ],
  "status": "enabled",
  "disabled_reason": "string",
  "secret_preview": "string",
  "secret": "string",
  "created_at": "2026-10-01T09:30:00Z",
  "updated_at": "2026-10-01T09:30:00Z"
}

إرسال حدث تجريبي

posthttps://api.saei.automize.sa/v1/webhook_endpoints/{id}/test

الصلاحية: webhooks:write
يعمل في وضع الاختبار

يرسل حدث webhook.test موقّعًا إلى هذه النقطة فقط. تابع نتيجته من قائمة عمليات الإرسال.

معاملات المسار

idstringمطلوب
معرّف العنصر.

حقول الاستجابة202· أُضيف الحدث التجريبي لقائمة الإرسال.

idstringمطلوب
object"webhook_delivery"مطلوب
livemodebooleanمطلوب
webhook_endpoint_idstringمطلوب
event_idstringمطلوب
event_typestringمطلوب
statusstringمطلوب
failed ستُعاد محاولته في next_attempt_at، وdead لن تُعاد محاولته.
إحدى القيمpendingsucceededfaileddead
attemptsintegerمطلوب
http_statusinteger | nullاختياري
duration_msinteger | nullاختياري
response_snippetstring | nullاختياري
last_errorstring | nullاختياري
next_attempt_atstring | nullاختياري
delivered_atstring | nullاختياري
created_atstring | nullاختياري
payloadobjectاختياري
جسم كل طلب ويب هوك. data.object هو نفس المورد الذي تُرجعه الواجهة (مثل message).
الحقول الفرعية (8)
- idstringمطلوب
  معرّف الحدث، ويُرسل أيضًا في ترويسة webhook-id. ثابت في كل إعادة محاولة، فاستخدمه لتجاهل التكرار.
- object"event"مطلوب
- typestringمطلوب
- versionstringمطلوب
  إصدار الحمولة. داخل الإصدار الواحد تُضاف الحقول فقط ولا تُحذف.
- created_atstringمطلوب
- livemodebooleanمطلوب
- workspace_idstringمطلوب
- dataobjectمطلوب
  الحقول الفرعية (2)
  objectobjectمطلوب
  previous_attributesobjectاختياري
  القيم التي تغيّرت كما كانت قبل التغيير، عند توفرها.

الأخطاء المحتملة2

422parameter_invalidحقل غير صالح
404resource_missingغير موجود

جرّبها

curl -X POST https://api.saei.automize.sa/v1/webhook_endpoints/we_01j9x3k2m4n5p6q7r8s9t0v1w2/test \
  -H "Authorization: Bearer $API_KEY"

الاستجابة

أُضيف الحدث التجريبي لقائمة الإرسال.

{
  "id": "del_01j9x3k2m4n5p6q7r8s9t0v1w2",
  "object": "webhook_delivery",
  "livemode": false,
  "webhook_endpoint_id": "string",
  "event_id": "string",
  "event_type": "string",
  "status": "pending",
  "attempts": 0,
  "http_status": 0,
  "duration_ms": 0,
  "response_snippet": "string",
  "last_error": "string",
  "next_attempt_at": "2026-10-01T09:30:00Z",
  "delivered_at": "2026-10-01T09:30:00Z",
  "created_at": "2026-10-01T09:30:00Z",
  "payload": {
    "id": "evt_01j9x3k2m4n5p6q7r8s9t0v1w2",
    "object": "event",
    "type": "message.delivered",
    "version": "2",
    "created_at": "2026-10-01T09:30:00Z",
    "livemode": false,
    "workspace_id": "ws_12",
    "data": {
      "object": {},
      "previous_attributes": {}
    }
  }
}

نقاط الواجهة

عرض أنواع الأحداث#

إعادة الإرسال الآن#

معاملات المسار

عرض نقاط استقبال الويب هوك#

إضافة نقطة استقبال ويب هوك#

الترويسات

جسم الطلب

جلب نقطة استقبال#

معاملات المسار

تعديل نقطة استقبال#

معاملات المسار

جسم الطلب

حذف نقطة استقبال#

معاملات المسار

عرض عمليات الإرسال#

معاملات المسار

معاملات الاستعلام

تدوير سر التوقيع#

معاملات المسار

إرسال حدث تجريبي#

معاملات المسار

عرض أنواع الأحداث

إعادة الإرسال الآن

عرض نقاط استقبال الويب هوك

إضافة نقطة استقبال ويب هوك

جلب نقطة استقبال

تعديل نقطة استقبال

حذف نقطة استقبال

عرض عمليات الإرسال

تدوير سر التوقيع

إرسال حدث تجريبي