Skip to content

Commit b47d1a5

Browse files
authored
docs(developer): add webhook 30-second response timeout notice to the Webhook Events article (#671)
1 parent ec17ecd commit b47d1a5

3 files changed

Lines changed: 6 additions & 2 deletions

File tree

src/content/docs/crowdin/project-management/webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ You will need to provide the following information to register a webhook:
4949

5050
* The webhook name (for example, “App Project Translated”).
5151
* The events to post to the URL. You can select either one event or a specific set of events.
52-
* The URL to which the webhook callbacks are sent as direct requests. Redirects are not supported and will result in a failed delivery. The endpoint must return a 2XX response within 30 seconds.
52+
* The URL to which the webhook callbacks are sent as direct requests. Redirects are not supported and will result in a failed delivery. The endpoint must return a `2XX` response within **30 seconds**.
5353
* The request method that indicates the desired action to be performed for a given resource (use either `GET` or `POST`).
5454
* The content type for the POST request method (`multipart/form-data`, `application/json`, or `application/x-www-form-urlencoded`).
5555
* For the `application/json` content type, you can select **Batch webhooks** to merge multiple events into a single request.

src/content/docs/developer/capabilities/webhooks.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ import groupDeleted from '/src/assets/code/webhooks/group.deleted.json?raw';
5959

6060
You can add webhooks to build integrations with the third-party services or with your backend. After you configure a webhook for the project, Crowdin will start sending POST or GET requests with data to the webhook URL via HTTP.
6161

62+
<Aside title="Response timeout">
63+
Your endpoint should return a `2XX` response within **30 seconds**. If processing takes longer, handle it asynchronously.
64+
</Aside>
65+
6266
## Configuring Webhooks
6367

6468
Webhook integration can be implemented at different levels, including Project, Account, or Organization level.

src/content/docs/enterprise/project-management/webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You will need to provide the following information to register a webhook:
5050

5151
* The webhook name (for example, "New translation added").
5252
* The events to post to the URL. You can select either one event or a specific set of events.
53-
* The URL to which the webhook callbacks are sent as direct requests. Redirects are not supported and will result in a failed delivery. The endpoint must return a 2XX response within 30 seconds.
53+
* The URL to which the webhook callbacks are sent as direct requests. Redirects are not supported and will result in a failed delivery. The endpoint must return a `2XX` response within **30 seconds**.
5454
* The request method that indicates the desired action to be performed for a given resource (use either GET or POST).
5555
* The content type for the POST request method (`multipart/form-data`, `application/json`, or `application/x-www-form-urlencoded`).
5656
* For the `application/json` content type, you can select **Batch webhooks** to merge multiple events into a single request.

0 commit comments

Comments
 (0)