Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk): describe Python delivery failures sent before shutdown

Yudhi Armyndharis16aed202bc3b
diff --git a/sdk/python/openwa/types.py b/sdk/python/openwa/types.py
index 0a983782f..92cfd8bab 100644
--- a/sdk/python/openwa/types.py
+++ b/sdk/python/openwa/types.py
@@ -962,9 +962,12 @@ class WebhookDeliveryFailure(TypedDict):
# The idempotency key the receiver would have deduped on.
idempotencyKey: NotRequired[str | None]
deliveryId: NotRequired[str | None]
- # Attempts recorded; 0 when the delivery was shed, refused or failed before sending.
+ # Attempts made before giving up; 0 when the delivery was not given up after retries (oversize or
+ # unserializable payload, capacity shed, or shutdown, possibly in a retry backoff after earlier
+ # attempts were sent).
attempts: int
- # Last HTTP status when the failure was a non-2xx response; None for a network or timeout error.
+ # Last HTTP status when the failure was a non-2xx response; None for a network or timeout error,
+ # or when attempts is 0.
lastStatusCode: NotRequired[int | None]
lastError: str
# ISO timestamp of when the failure was first recorded.