Update troubleshooting.md #1633
Merged
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
Formatting suggestions
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Overall readability score: 58.04 (🟢 +0)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
pzaichkina
approved these changes
Dec 23, 2025
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| - "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. | ||
| - **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. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('were exhausted').
| - "Sending" indicates that the process of sending the webhook has begun but there have been no delivery attempts yet. | ||
| - **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. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Passive] In general, use active voice instead of passive voice ('been sent').
| 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 multiple 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. | ||
| During the recovery of mutiple messages, we will send all messages at once, applying some delay between messages. This is to prevent overloading the webhook consumer endpoint. If your system has rate limiting in place, consider this scenario to avoid further failures. See details of [webhook endpoint rate limiting](/using-the-api/webhooks/create-consumer#endpoint-rate-limits). |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Google.Will] Avoid using 'will'.
|
Link check results for preview deployment (https://codat-docs-git-pj-simpson-bold-list-codat.vercel.app): |
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.
Updating to make some bullet points bold, as per @dcoplowe 's suggestion.
Note
Docs update (webhooks troubleshooting)
Message Statusas bolded bullet points for clarityMultiple messagesrecovery guidance to state messages are sent at once with delays between them; adds link toendpoint rate limitsand removes support-escalation noteWritten by Cursor Bugbot for commit 3c34c1e. This will update automatically on new commits. Configure here.