Skip to content

Document webhook at-least-once delivery and X-Bugsee-Delivery #22

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

Merged
krassx merged 1 commit into from
Sep 1, 2026
+14 −3
Merged

Document webhook at-least-once delivery and X-Bugsee-Delivery #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/webhooks/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ All webhook payloads has common structure, like the one below:

|Field|Type|Description|
|---|---|---|
|id|String|Unique request ID|
|id|String|Stable delivery id. Also sent as the `X-Bugsee-Delivery` request header. Same value on every retry of this delivery — use it to dedupe.|
|type|String|Event type. One of the listed above|
|created_on|String|Date and time of event generation (ISO date format)|
|payload|Object|Event data|
Expand Down
15 changes: 13 additions & 2 deletions docs/webhooks/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,22 @@ To start receiving notifications via Webhooks you only need to set it up once vi

## Responding

Your server must respond with HTTP 200 to inform Bugsee that you accepted and handled request. Any other response may be treated as failure.
Your server must respond with **HTTP 200** to inform Bugsee that you accepted and handled the request. Any other status (including 201 and 204) is treated as a failure.

## Delivery and retries

Delivery is **at-least-once**. A transient failure (timeout, 408, 429, 5xx, network error) is retried; your handler may see the same event more than once.

Each request carries a stable delivery id in both places — use either to dedupe:

- JSON envelope field `id`
- request header `X-Bugsee-Delivery`

Both values are the same string and stay the same across retries of that delivery.

## Rate limits

For now, we do not set any limits on requests being made to your servers. However, if there will be 5 or more consecutive failures, webhook will be marked as disabled and any further activity notifications will not be passed through it. To reset disabled state, make sure you've provided valid URL and enable webhook in web dashboard.
There is no rate limit on requests to your server. Five or more **consecutive terminal** failures disable the webhook; further events are not sent until you re-enable it in the dashboard. Transient failures that later succeed do not count.