Skip to content

Update troubleshooting.md #1633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update troubleshooting.md #1633

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eeea4fd
Update troubleshooting.md
pj-simpson Jul 15, 2025
2193042
Update troubleshooting.md
pj-simpson Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/using-the-api/webhooks/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ A webhook consumer endpoint which is disabled after the 5 min retry, but then re

## Message Status

- "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.
- **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.

## Recover failed and missed messages

Expand Down Expand Up @@ -67,7 +67,7 @@ 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.
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 see our docs around rate limiting endpoints](/using-the-api/webhooks/create-consumer).

### Idempotency

Expand Down
Loading