mention webhook retry intervals in webhook docs

for github issue #31, feedback from cuu508
This commit is contained in:
Mechiel Lukkien 2024-04-19 10:33:28 +02:00
parent e702f45d32
commit 962575f21b
No known key found for this signature in database
2 changed files with 8 additions and 6 deletions

View file

@ -56,9 +56,10 @@ per account.
A webhook is delivered by an HTTP POST with headers "X-Mox-Webhook-ID" (unique 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, 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 starting at 1), and a JSON body with the webhook data. Failing webhook
failures are retried at a schedule similar to message deliveries, until deliveries are retried with backoff, each time doubling the interval between
permanent failure. 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 See [webhook.Outgoing] for the fields in a webhook for outgoing deliveries, and
in particular [webhook.OutgoingEvent] for the types of events. in particular [webhook.OutgoingEvent] for the types of events.

View file

@ -66,9 +66,10 @@ per account.
A webhook is delivered by an HTTP POST with headers "X-Mox-Webhook-ID" (unique 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, 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 starting at 1), and a JSON body with the webhook data. Failing webhook
failures are retried at a schedule similar to message deliveries, until deliveries are retried with backoff, each time doubling the interval between
permanent failure. 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 See [webhook.Outgoing] for the fields in a webhook for outgoing deliveries, and
in particular [webhook.OutgoingEvent] for the types of events. in particular [webhook.OutgoingEvent] for the types of events.