Skip to content

Commit fbf49cf

Browse files
committed
Enhance Webhooks Setup documentation on event ordering and processing recommendations
1 parent d41e466 commit fbf49cf

1 file changed

Lines changed: 15 additions & 2 deletions

File tree

articles/LCPublicAPI/docs/webhooks/Webhooks-setup.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,21 @@ stoplight-id: eg4ja9nrs9wtk
66

77
A webhook is a web callback by which Trados Cloud Platform notifies an external application when a specific event occurs in a specific account in Trados Cloud Platform. You can subscribe to events by registering webhooks from within the Trados UI.
88

9-
> [!NOTE]
10-
> When integrating with our webhook service, please be aware that we cannot guarantee the order of webhook event deliveries. This means that notifications may arrive out of sequence, and consumers should not rely on receiving messages in a specific order. Instead, make use of the `timestamp` field to determine the event generation time.
9+
## Event Ordering
10+
11+
When integrating with our webhook service, please be aware that **we cannot guarantee the order of webhook event deliveries**. Notifications may arrive out of sequence, and consumers should not rely on receiving messages in a specific order. This is due to the following reasons:
12+
13+
- Webhooks are sent in parallel for performance reasons
14+
- If your endpoint is temporarily unavailable, messages will be retried later (see [Retry policies](#retry-policies))
15+
- Network conditions and other factors can affect delivery timing
16+
17+
**Recommended approach:** Each webhook payload includes a `timestamp` field representing the actual moment when the event occurred (not when the webhook was sent). Use this timestamp to:
18+
19+
1. Determine the correct chronological order of events
20+
2. Implement idempotent processing by tracking the last processed timestamp per entity
21+
3. Ignore webhooks for an entity if they have an older timestamp than the last successfully processed event for that entity
22+
23+
This pattern ensures your integration handles events correctly regardless of delivery order.
1124

1225
## Subscribe to Webhook events
1326

0 commit comments

Comments
 (0)