Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(webhook): say which unsent deliveries the outbox replays

Yudhi Armyndharis1d467488f9f0
diff --git a/src/modules/webhook/webhooks-list.controller.ts b/src/modules/webhook/webhooks-list.controller.ts
index 7eaf7a404..b3b442652 100644
--- a/src/modules/webhook/webhooks-list.controller.ts
+++ b/src/modules/webhook/webhooks-list.controller.ts
@@ -18,8 +18,10 @@ export class WebhooksListController {
status: 200,
description:
'Deliveries that exhausted their retries (attempts > 0) and deliveries not sent (attempts 0: shed, ' +
- 'refused at shutdown, oversize or a preflight failure; the outbox replays them). A later successful ' +
- 'delivery removes the row. Most recent first.',
+ 'refused at shutdown, oversize or a preflight failure). A direct delivery that shutdown stops in a retry ' +
+ 'backoff also records attempts 0, although its earlier attempts were sent. The outbox replays shed ' +
+ 'deliveries and those stopped by shutdown; oversize and preflight-failed ones on a first dispatch are ' +
+ 'final. A later successful delivery removes the row. Most recent first.',
type: [WebhookDeliveryFailureDto],
})
@ApiQuery({ name: 'sessionId', required: false, description: 'Filter to a single session' })