mention webhook retry intervals in webhook docs

for github issue #31, feedback from cuu508
mjl- · Apr 19, 2024 · 962575f · 962575f
1 parent e702f45
commit 962575f
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 6 deletions.
diff --git a/webapi/doc.go b/webapi/doc.go
@@ -56,9 +56,10 @@ per account.
 
 A webhook is delivered by an HTTP POST with headers "X-Mox-Webhook-ID" (unique
 ID of webhook) and "X-Mox-Webhook-Attempt" (number of delivery attempts,
-starting at 1), and a JSON body with the webhook data.  Webhook delivery
-failures are retried at a schedule similar to message deliveries, until
-permanent failure.
+starting at 1), and a JSON body with the webhook data.  Failing webhook
+deliveries are retried with backoff, each time doubling the interval between
+attempts, at 1m, 2m, 4m, 7.5m, 15m and unwards, until the last attempt after a
+16h wait period.
 
 See [webhook.Outgoing] for the fields in a webhook for outgoing deliveries, and
 in particular [webhook.OutgoingEvent] for the types of events.

diff --git a/webapi/gendoc.sh b/webapi/gendoc.sh
@@ -66,9 +66,10 @@ per account.
 
 A webhook is delivered by an HTTP POST with headers "X-Mox-Webhook-ID" (unique
 ID of webhook) and "X-Mox-Webhook-Attempt" (number of delivery attempts,
-starting at 1), and a JSON body with the webhook data.  Webhook delivery
-failures are retried at a schedule similar to message deliveries, until
-permanent failure.
+starting at 1), and a JSON body with the webhook data.  Failing webhook
+deliveries are retried with backoff, each time doubling the interval between
+attempts, at 1m, 2m, 4m, 7.5m, 15m and unwards, until the last attempt after a
+16h wait period.
 
 See [webhook.Outgoing] for the fields in a webhook for outgoing deliveries, and
 in particular [webhook.OutgoingEvent] for the types of events.