Update troubleshooting.md #1631
Merged
+19
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Overall readability score: 58.05 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
dcoplowe
approved these changes
Jul 14, 2025
| @@ -56,6 +67,12 @@ 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 the triple-dot options menu of a specific message, and choose **Replay > Replay all failed messages since this time**. | |||
|
|
|||
| During the recovery of mutiple messages, all messages will be sent at once with some jitter applied in order to prevent overloading the webhook consumer endpoint. If your system has rate-limiting in place, the number of messages to recover may be an important consideration to avoid further failures. Please reach out to Codat Support if unsure. | |||
There was a problem hiding this comment.
@pj-simpson Svix supports rate limiting endpoints. Could you ask them and confirm that retries will also adhere to end point rate limits? If so, they can control this in the portal. Can we add a rate limit section after Webhoook security on the following page: /using-the-api/webhooks/create-consumer?
Comment on lines
+32
to
+35
| - "Success" indicates that there was at least one attempt for that message that succeeded against it's endpoint. | ||
| - "Failure" indicates that all attempts were exhausted, and none of them succeeded. | ||
| - "Attempting" indicates that at least one attempt has been sent and there are further attempts scheduled as part of the retry policy. | ||
| - "Sending" indicates that the process of sending the webhook has begun but there have been no delivery attempts yet. |
There was a problem hiding this comment.
Can we change these to bold font? Success
dcoplowe
reviewed
Jul 14, 2025
|
|
||
| An event that fails three times and then succeeds will be delivered roughly 35 minutes and 5 seconds after the initial attempt. | ||
|
|
||
| A webhook consumer endpoint which is disabled after the 5 min retry, but then re-enabled approx 3 hours after that, should have 3 more message attempts scheduled, (5 hours, 10 hours, Additional 10 hours). |
There was a problem hiding this comment.
Is that 5 hours from the first message attempt or from when the consumer was reenabled?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
There have been recent issues caused by poor understanding of how our webhooks work on both the part of Codat internally & our consumers. The intention of this PR is to root out some of the areas of ambiguity.
Type of change
Please delete options that are not relevant.