From d76869980c7071e8642dd843941f7e5ab5d23e17 Mon Sep 17 00:00:00 2001 From: David Coplowe Date: Tue, 26 Nov 2024 18:27:16 +0000 Subject: [PATCH] Fixed the docs --- blog/241125-webhooks-replay-missed-messages.md | 8 +++----- docs/using-the-api/webhooks/troubleshooting.md | 14 +++++++------- 2 files changed, 10 insertions(+), 12 deletions(-) diff --git a/blog/241125-webhooks-replay-missed-messages.md b/blog/241125-webhooks-replay-missed-messages.md index c4c0914b0..0b8d69945 100644 --- a/blog/241125-webhooks-replay-missed-messages.md +++ b/blog/241125-webhooks-replay-missed-messages.md @@ -13,7 +13,7 @@ You can now replay missed messages from the previous two weeks with this update Our webhooks service caches all generated events even if no consumers have been configured. With this latest update to the service, you can request Codat to resend all events missed in the previous two weeks. You can do so when you start using the webhooks service, on a consumer-by-consumer basis. -![Display replay button](/img/use-the-api/webhooks-replay-missed-messages.png) +![A fragment of the UI that displays multiple message recovery options](/img/use-the-api/0046-multiple-message-retry.png) ## Who is this relevant for? @@ -26,9 +26,7 @@ You can use this functionality immediately if you are already using our new webh 1. Navigate to **Settings > Webhooks > Configure consumers** in the [Codat Portal](https://app.codat.io/monitor/events). 2. Select an existing webhook consumer or create a new one. -3. In the detailed consumer view, click theclick the triple-dot menu and select **Replay missing messages**. +3. In the detailed consumer view, click the click the triple-dot menu and select **Replay missing messages**. 4. Select the starting date for the messages you wish to replay and confirm by pressing **Replay**. -Alternatively, you can scroll the consumer detail page to view the **Message Attempts** section and use the triple-dot menu to replay an individual message. See our detailed documentation on how to [Recover failed messages](/using-the-api/webhooks/troubleshooting#recover-failed-messages). - -![Select replay options](/img/use-the-api/webhooks-replay-missed-messages-duration.png) +Alternatively, you can scroll the consumer detail page to view the **Message Attempts** section and use the triple-dot menu to replay an individual message. See our detailed documentation on how to [Recover failed messages](/using-the-api/webhooks/troubleshooting#recover-failed-and-missed-messages). \ No newline at end of file diff --git a/docs/using-the-api/webhooks/troubleshooting.md b/docs/using-the-api/webhooks/troubleshooting.md index 45cbd7b44..de54f34b7 100644 --- a/docs/using-the-api/webhooks/troubleshooting.md +++ b/docs/using-the-api/webhooks/troubleshooting.md @@ -25,9 +25,14 @@ An event that fails three times and then succeeds will be delivered roughly 35 m ::: -## Recover failed messages +## Recover failed and missed messages -If you want to resend or recover one or more messages in case of your app's downtime or incorrect configuration, you can do so in the [Codat Portal](https://app.codat.io/monitor/events). +There are two types of messages that can be recovered: + +- **Failed messages** occur when all attempts to deliver the message have been exhausted. +- **Missed messages** result from scenarios such as the endpoint being disabled, the endpoint not existing at the time of sending (but created afterward), or the endpoint initially configured to listen to other event types and now updated to include additional ones. + +If you want to resend or recover one or more messages in case of your app's downtime or incorrect configuration, you can do so in the [Codat Portal](https://app.codat.io/monitor/events). Navigate to **Monitor > Webhooks > Events > Endpoints** to view your consumer endpoints and retry the messages manually or automatically. @@ -51,11 +56,6 @@ Then, click the triple-dot menu on the right and choose one of the applicable op For more granular date control, you can scroll to the endpoint's message attempts, click on the triple-dot options menu of a specific message, and choose **Replay > Replay all failed messages since this time**. -:::info Missing messages - -A message could be missing if the endpoint was disabled, did not exist and was created after the send date, or was listening to other event types and is now listening to an additional one. -::: - ## Endpoint failures Your webhook consumer endpoint could fail due to a variety of reasons. Let's have a look at resolving the most common ones.