Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk-java): describe never-sent rows on WebhookDeliveryFailure

Yudhi Armyndharis2cbee8669616
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java b/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java
index 00fb8a6b5..eeb8adad6 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/model/WebhookDeliveryFailure.java
@@ -1,8 +1,8 @@
package com.rmyndharis.openwa.model;
/**
- * A webhook delivery abandoned after every retry, as listed by the delivery-failure log. Optional
- * fields are {@code null} when absent.
+ * A webhook delivery the gateway gave up on or could not dispatch, as listed by the
+ * delivery-failure log. Optional fields are {@code null} when absent.
*/
public record WebhookDeliveryFailure(
String id,
@@ -13,10 +13,18 @@ public record WebhookDeliveryFailure(
/** The idempotency key the receiver would have deduped on. */
String idempotencyKey,
String deliveryId,
- /** Total attempts made before giving up. */
+ /**
+ * Delivery attempts recorded; 0 when the delivery was shed, refused or failed before sending
+ * (oversize payload, webhook:before hook error, capacity shed or shutdown). A direct delivery
+ * that shutdown caught in a retry backoff also records 0, although its earlier attempts were
+ * sent.
+ */
int attempts,
- /** Last HTTP status when the failure was a non-2xx response; {@code null} for a network or timeout error. */
+ /**
+ * Last HTTP status when the failure was a non-2xx response; {@code null} for a network or
+ * timeout error, or when attempts is 0.
+ */
Integer lastStatusCode,
String lastError,
- /** ISO timestamp of when the delivery was finally abandoned. */
+ /** ISO timestamp of when the failure was recorded. */
String createdAt) {}