الموارد · 54
Webhooks: معالجة التكرارات والتأخيرات والاسترداد
حوّل الإشعار المُستلم إلى تأثير تجاري فريد وقابل للتتبع وقابل للاسترداد بعد الفشل.
مُحدَّث · 9 min
ما يُساعد هذا الدليل على تحقيقه
- مصادقة الإشعارات
- فصل الاستلام عن المعالجة
- منع التأثيرات المكررة
- استعادة الأحداث المحظورة
فحص سريع
- ما هي البايتات المُوقَّعة؟
- متى يكون الاستلام دائمًا؟
- هل يمكن لعاملين العمل معًا؟
- هل يضمن الموفر ترتيب التسليم؟
- كيف يتم العثور على حدث مفقود؟
طريقة خطوة بخطوة
- 1
قراءة عقد الموفر
أنواع السجلات، والإصدار، وسياق الحساب، والتوقيعات، والتوقيت، وقواعد إعادة المحاولة. تنص Stripe على أن ترتيب التسليم غير مضمون، وقد تحدث عمليات مكررة؛ لذا لا تُطبق تأخيرًا خاصًا بـ Stripe على كل واجهة برمجة تطبيقات.
المُخرَج: عقد موفر مؤرخ.
- 2
التحقق قبل التأثيرات
التحقق من التوقيعات باستخدام المكتبة والنص الخام المطلوب من قِبل الموفر. تحديد الأحجام والأنواع المقبولة. اختبر التوقيعات غير الصالحة وسياق الحساب غير المتوقع في بيئة مُصرَّح بها دون تسجيل البيانات السرية.
المُخرَج: حالات الرفض دون أي تأثير.
- 3
الحفظ قبل الإقرار.
افصل الاستلام الدائم عن المعالجة البطيئة. إذا لم يتمكن الطابور من قبول الحدث، فلا تُبلغ عنه على أنه مُحتفظ به. يُشير النجاح إلى الاستلام بموجب عقدك، وليس بالضرورة إتمام الإجراء التجاري.
المُخرَج: حالات الاستلام، والمعالجة، والإتمام، والحظر.
- 4
فرض التكرار.
حدد مفاتيح الحدث وهوية التأثير التجاري. اختبر التكرارات المتزامنة بدلاً من التسليم التسلسلي فقط. يمكن لفحص أولي بدون قيود ذرية أو تأمين أن يسمح لعاملين بإنشاء نفس التأثير.
المُخرَج: دليل على تفرد التأثير.
- 5
معالجة التأخير والفوضى.
لا تفترض أن إشعارًا قديمًا يصف الحالة الحالية. راجع المصدر عندما يسمح العقد بذلك، وطبّق انتقالات الأعمال المُدقَّقة. احتفظ بالأحداث التي لا يمكن تفسيرها بعد.
المُخرَج: اختبارات الانتقالات والترتيب العكسي.
- 6
التوفيق وإعادة التشغيل.
إعداد قائمة انتظار الأخطاء مع تحديد المالك والسبب والمحاولات والإغلاق. حافظ على الحماية من التكرار أثناء إعادة التشغيل. قارن المزوّد والتطبيق دوريًا: لا يُثبت نجاح الاسترداد عدم فقدان أي حدث.
المُخرَج: إجراء الاسترداد وتقرير التباين.
ورقة عمل قابلة لإعادة الاستخدام
أكمل بملاحظاتك المعتمدة. هذه الحقول عبارة عن نموذج عمل، وليست نتائج مُلاحظة.
| الحقل | المعلومات المطلوب تسجيلها |
|---|---|
| الحدث | المزوّد، الحساب، المعرّف، والإصدار |
| الإيصال | التوقيع المُدقّق والطابع الزمني الدائم |
| التأثير | مفتاح العمل، الحالة، ودليل التفرّد |
| الاسترداد | السبب، المحاولة، المالك، والإغلاق |
مثال عملي افتراضي
حالة توضيحية
مثال افتراضي: البيانات لا تصف عميلاً أو نتيجة مرصودة. يصل إشعار الدفع نفسه مرتين، وتحاول المعالجة تفعيل الاشتراك نفسه مرتين.
القرار والأدلة المتوقعة
تحقق من أصالة الإشعار واكتشف التكرار وطابق حالة الفاتورة والاشتراك مع المصدر المعتمد. أكد أثراً تشغيلياً واحداً وسجل التكرار دون نسخ أسرار. إقرار الاستلام عبر HTTP لا يثبت صحة التفعيل.
تمييز الآليات
| الآلية | الغرض | التحقق أو التقييد |
|---|---|---|
| التوقيع. | التحقق من المصدر بموجب العقد. | لا يجعل التأثيرات فريدة. |
| إزالة التكرارات | التعرف على الإشعارات المتكررة | التحقق من التزامن والتأثيرات التجارية |
| التوفيق | إيجاد حالات الحذف والاختلاف | تحديد المصدر والفترة الزمنية |
مؤشرات الإدارة
| المؤشر | ما يقيسه | الإجراء الأول |
|---|---|---|
| عمر قائمة الانتظار | تأخير الأحداث غير المكتملة | فحص الأقدم |
| تأثيرات مكررة | تكرار الإجراءات التجارية بشكل خاطئ | تصحيح الذرية |
| فجوات المصدر/التطبيق | حالات غائبة أو متباينة | التوفيق مع دليل الإغلاق |
الأخطاء الشائعة
- التحليل قبل التحقق من صحة نص الرسالة الموقعة
- الإقرار قبل الاستلام الدائم
- افتراض التسليم المرتب
- اختبار التكرارات بالتسلسل فقط
الأسئلة المتكررة
هل يعني نجاح HTTP اكتمال المعالجة؟
يعتمد ذلك على العقد. مع المعالجة غير المتزامنة، ينبغي أن يضمن ذلك استلامًا دائمًا مع تتبع حالة العمل بشكل منفصل.
هل يمكن افتراض التسليم لمرة واحدة فقط؟
تصميم النظام للتعامل مع حالات التكرار والفشل في ظل العقد الفعلي، مع مراعاة التأثيرات الفريدة وإمكانية التسوية.
هل ينبغي الاحتفاظ بالبيانات كاملة؟
فقط عند الضرورة مع إمكانية الوصول والاحتفاظ المناسبة. يجب أن تدعم الآثار الدنيا التشخيص والاستعادة دون إخفاء أي معلومات.
ثبات الأثر وعقود إعادة محاولة API
الملاحظات المرجعية المفصّلة متاحة باللغة الإنجليزية في هذه النسخة.
Separate request retries from notification repeats
An outgoing API request key, a received-event identifier and a business-effect identity serve different roles.
- Define provider, account, event and effect before selecting a deduplication key.
- Test concurrent workers and an unknown external-effect outcome.
- Reconcile business state with the source; a valid signature does not make processing unique.
Compare idempotency contracts →
References reviewed · RFC 9110 · §9.2.2, §10.2.3 · RFC 6585 · §4 · Stripe
Webhooks: التوقيع وإعادة الإرسال
الملاحظات المرجعية المفصّلة متاحة باللغة الإنجليزية في هذه النسخة.
Authenticate a delivery, retain the event and control its effect
A webhook signature answers a specific question: do the received bytes match those authenticated with the expected key? It guarantees neither freshness nor uniqueness nor successful business processing. Separate these decisions in the receipt contract so that the integration can be observed and recovered.
The signature and recovery rules below belong to the cited Stripe and GitHub contracts. The timeline and ten cases are fictional exercises; this page activates no endpoint, real secret or payment mechanism. Use official libraries and test the relevant provider configuration for a real integration.
Stripe and GitHub: six differences to retain
| Control | Stripe | GitHub |
|---|---|---|
| Signature header | Stripe-Signature contains t and one or more v1 signatures. The documented active scheme is v1. | X-Hub-Signature-256 contains a SHA256 HMAC prefixed with sha256=. |
| Authenticated message | Text timestamp, a period and the raw body: timestamp + "." + body. | The raw delivery body. Transport headers are not added to this HMAC message. |
| Freshness and replay | The timestamp is authenticated. Documentation states a five-minute default tolerance in its libraries; each retry receives a new timestamp and signature. | The body HMAC alone provides no freshness proof equivalent to Stripe’s timestamp. Plan duplicate detection and recovery according to the contract. |
| Identity to track | event.id identifies repeated delivery. Stripe also describes distinct events that may require correlation using data.object.id and event.type. | X-GitHub-Delivery identifies the delivery; requested redelivery retains that identifier. Its value remains outside the body authenticated by the HMAC described here. |
| Delivery failure | Live-mode automatic retries for up to three days with exponential backoff. A manual resend does not automatically cancel these retries. | GitHub does not automatically redeliver failures. Arrange manual redelivery or application-managed recovery using the available APIs. |
| Fast acknowledgement | Return a 2xx quickly, before lengthy work. Durable receipt before acknowledgement is the architectural policy of our exercise. | Respond with 2xx within ten seconds according to the documentation. A queue separates receipt from business processing. |
Retain three separate identities
| Identity | Fictional example | Purpose and limit |
|---|---|---|
| Transport attempt | delivery_attempt_02 | One event can arrive several times. An attempt’s timestamp and signature are not a business key. |
| Provider event | provider + account + environment + evt_training_001 | Recognise the same event within its scope. Define retention and recovery behaviour; a bare identifier without context may be insufficient. |
| Business effect | tenant_7 + case_42 + initial_activation | Prevent a second initial activation here. The key belongs to this operation; do not discard all future object updates by reducing them to the object identifier alone. |
Three bodies, six HMACs: what reformatting changes
Public exercise-only key: training-only-key-not-a-secret. Fixed timestamp: 1792663200, corresponding to 2026-10-22 at 10:00:00 UTC. Strings use UTF-8 with no trailing newline. A and B represent the same JSON object but have different bytes; C changes case_42 to case_43.
| Body | UTF-8 bytes | Exact string, written as a JSON string |
|---|---|---|
| A | 68 | "{\"id\":\"evt_training_001\",\"type\":\"evidence.ready\",\"object\":\"case_42\"}" |
| B | 73 | "{\"id\": \"evt_training_001\", \"type\": \"evidence.ready\", \"object\": \"case_42\"}" |
| C | 68 | "{\"id\":\"evt_training_001\",\"type\":\"evidence.ready\",\"object\":\"case_43\"}" |
| Body / scheme | Message used | Calculated hexadecimal HMAC-SHA256 |
|---|---|---|
| A · GitHub | body | d6ac0a608c901617782f3b7aef64198718e3affd410a219b22b84da008235364 |
| A · Stripe v1 | timestamp + "." + body | 0ad9c9f7c0df2d8a8265113e641d92f57ce0dffd703a7cf9f13c4163e21bf6dc |
| B · GitHub | body | c9c47b1432282b9a3c2cbf4aded2c750deed235ac948dffe248488b84a4af73d |
| B · Stripe v1 | timestamp + "." + body | 0ad8e262a5870766d4cce864f50a5feac65a3004e3c3208184da9cc075c7abd6 |
| C · GitHub | body | 55162fc08e3cb0efd0eb082978ba61a88cf3624ffc5322f19ab73d91466a616d |
| C · Stripe v1 | timestamp + "." + body | d7f4014489a900399a7049daa3e8f1ce2b208bf95b93c43492cb68f7d6f1b791 |
These results use the documented message constructions with a publicly displayed key and invented data. They are not authentic Stripe or GitHub deliveries. Different JSON serialization, even if semantically equivalent, must not replace the original body before verification. In production, compare in constant time and manage key rotation according to the selected library and contract.
Stripe tolerance parameter: the value 0 disables recency checking in the libraries described by its documentation. It does not mean “accept only the exact second”. Do not transfer the OAuth/OIDC example’s clock policy to this parameter.
Seven records for one local effect
Fictional scenario on 2026-10-22, all times UTC. Authenticate before admission and persist receipt before responding. An atomic constraint protects initial activation in the same database as its business state. Counts below are calculated for this exercise and describe no client outcome.
| UTC time | Observed signal | Scenario decision | Cumulative local effects |
|---|---|---|---|
| 10:00:00 | evt_training_001 admitted; response lost | Durable receipt, pending state; no business effect executed yet. | 0 |
| 10:00:01 | Worker A claims the event | Atomic work reservation; processing state. | 0 |
| 10:00:01 | Worker B sees the same event | Do not create a second processing owner or execute again. | 0 |
| 10:00:02 | Worker A commits the local transaction | Atomically write initial activation and its completed state. | 1 |
| 10:00:03 | New delivery of evt_training_001 | Authenticate the new attempt, find the completed event and acknowledge without a second effect. | 1 |
| 10:00:04 | evt_training_002 targets the same initial activation | Retain the distinct event; this business-operation key already exists. | 1 |
| 10:00:05 | evt_training_003 carries an earlier state | Reject a regressive transition under the exercise policy and reconcile the source. | 1 |
The transaction described protects a local effect. It does not make an external service call atomic. After an unknown external result, retain uncertainty, query the source and apply the available idempotency mechanism before retrying. A transactional outbox can organise emission; it does not establish a universal exactly-once guarantee.
Ten denial and recovery tests to prepare
01 · Invalid signature: no effect
Present a delivery whose HMAC does not match the received body.
Expected: reject before admission and any effect. Retain a redacted reason and configuration version, without recording the key, token or sensitive body content.
02 · Reformatted JSON with the original signature
Replace A with B while keeping the signature computed for A. Both JSON strings decode to the same object.
Expected: verification failure. Capture the raw body at the right framework stage; do not try different reformattings to recover the signature.
03 · Correct signature, stale timestamp
In a Stripe test, authenticate a 09:50:00 timestamp while the acceptance-test clock is 10:00:00, with a configured five-minute tolerance.
Expected: reject freshness despite a correct HMAC. Separate message integrity, delivery age and event creation age.
04 · Same event, newly authenticated attempt
Receive two deliveries of the same event.id; the Stripe retry has its own timestamp and signature.
Expected: authenticate each attempt, then find durable state. A different signature does not justify a second business effect.
05 · Two events, one initial activation
Receive two event identifiers requesting the same fictional initial activation of case_42.
Expected: record both events and protect this operation with its business key. Do not apply this rule blindly to legitimate successive updates of the same object.
06 · Two workers at the same instant
Start two workers on the same pending item in the authorised test environment.
Expected: atomic acquisition and one effect transaction. “Read absent, then insert” without a constraint can allow both workers through; inspect business results, not logs alone.
07 · Queue unavailable before acknowledgement
Simulate queue or database failure before receipt has been durably confirmed.
Expected under our architecture: do not acknowledge as though the event were retained. Exercise the provider’s recovery strategy; GitHub does not automatically redeliver failures.
08 · Response lost after durable receipt
Drop the response after notification persistence; let processing continue under the exercise policy.
Expected: the next attempt finds pending, processing or completed state. The sender may not know receipt succeeded; network uncertainty must not duplicate the effect.
09 · Old event after a newer state
Deliver a notification with an earlier state after a newer notification.
Expected: apply permitted business transitions and reconcile current state when necessary. A fresh signing timestamp can carry an old event; it does not prove business-state novelty.
10 · Manual recovery overlaps automatic retry
Send manual recovery and Stripe automatic retry towards the same event.
Expected: both paths use the same concurrency and idempotency controls. A successful manual resend does not itself cancel automatic retries; verify closure with the provider.
Six useful operating records
- Dated provider contract: environment, account, type, version, signature, timing and recovery.
- Redacted admission trace: internal reference, verification result, clock and policy version.
- Durable event state, work owner and evidence that the uniqueness constraint was tested.
- Effect identity and legitimately repeatable operations; separate the event from the business object.
- Failure queue with cause, attempt count, owner, next action and verified closure.
- Source/application reconciliation over a defined period, including never-received notifications and uncertain external effects.
Provider contracts and primary sources
- Stripe · Webhooks · Living documentation · reviewed 2026-10-22
Event delivery behaviors · Handle duplicate events · Verify manually · Preventing replay attacks - Stripe · Manage webhook endpoints · Living documentation · reviewed 2026-10-22
Process undelivered events · Resolve signature verification errors - GitHub · Validating webhook deliveries · Living documentation · reviewed 2026-10-22
HMAC-SHA256 · X-Hub-Signature-256 · raw payload · constant-time comparison - GitHub · Best practices for using webhooks · Living documentation · reviewed 2026-10-22
Respond within 10 seconds · X-GitHub-Delivery · redelivery retains the identifier - GitHub · Handling failed webhook deliveries · Living documentation · reviewed 2026-10-22
No automatic redelivery · manual or application-managed recovery
Sources reviewed on
أخطاء API: الأنواع والحالات والأدلة
الملاحظات المرجعية المفصّلة متاحة باللغة الإنجليزية في هذه النسخة.
An error response establishes neither failure nor safe replay
After interruption or an inconsistent response, a call may have produced an effect. Problem Details improves description; it does not prove no processing occurred or provide a universal retry policy.
- Preserve HTTP status, received body and permitted operation identifier in controlled traces.
- Check business state and idempotency rules before repeating an action.
- Test public messages without exposing secrets, internal paths or account details.
Explore problem types and eight fictional responses →
IETF · M. Nottingham, E. Wilde, S. Dalal · RFC 9457 · July 2023 · obsoletes RFC 7807 · §3.1, §3.2, §4.2, §5
المراجع الرسمية
تدعم المراجع الطريقة. قم بتكييف عمليات التحقق مع سياقك؛ فهي ليست شهادة. قد تكون عناوين المراجع الأصلية والوثائق المصدرية بلغة أخرى.
تاريخ مراجعة المراجع .
- Stripe — Webhooks
- Stripe — Process undelivered webhook events
- GitHub · Validating webhook deliveries
- GitHub · Best practices for using webhooks
- GitHub · Handling failed webhook deliveries
- IETF · M. Nottingham, E. Wilde, S. Dalal · RFC 9457
- IETF · RFC 9110 — Retry-After et idempotence HTTP
- IETF · RFC 6585 — 429 Too Many Requests
- AWS Builders’ Library · Timeouts, retries, and backoff with jitter
- Stripe · Idempotent requests
- Stripe · API v2 overview — Idempotency
- Stripe · Advanced error handling
