From 62c83c746eb8d4e9cfacdcf59c3f6c583e29bd33 Mon Sep 17 00:00:00 2001 From: Peter Simpson <40800258+pj-simpson@users.noreply.github.com> Date: Tue, 15 Jul 2025 10:34:23 +0100 Subject: [PATCH 1/2] Update create-consumer.md Adding information about rate limit controls. --- docs/using-the-api/webhooks/create-consumer.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/using-the-api/webhooks/create-consumer.md b/docs/using-the-api/webhooks/create-consumer.md index 69373183b..f0d98382f 100644 --- a/docs/using-the-api/webhooks/create-consumer.md +++ b/docs/using-the-api/webhooks/create-consumer.md @@ -499,6 +499,16 @@ svix verify --secret whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw --msg-id msg_p5jXN8A +## Endpoint Rate Limits + +If your application can only handle a limited number of requests in a given time period, you can protect it from becoming overloaded by setting a rate limit on a given endpoint. + +The rate limit is defined as a maximum number of messages per second to send to that endpoint. After the limit is reached, requests will get throttled to keep their frequency under the defined limit. + +Please note that the actual rate of messages can sometimes be slightly above the enforced rate limit. + +webhookratelimits + ## Transform webhook properties You may want to modify a webhook's properties (e.g. HTTP method, target URL, and message schema) before it is sent to your application to better fit your needs. To do so, you can now apply a transformation to the webhook following these steps: From 07eab4eac5d1b8b23fcbf9f726ab0d1d5cfe3b34 Mon Sep 17 00:00:00 2001 From: Polina <112084241+pzaichkina@users.noreply.github.com> Date: Tue, 18 Nov 2025 15:45:35 +0000 Subject: [PATCH 2/2] Edits Edits made to the new rate limit section --- docs/using-the-api/webhooks/create-consumer.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/using-the-api/webhooks/create-consumer.md b/docs/using-the-api/webhooks/create-consumer.md index f0d98382f..e1f90b41d 100644 --- a/docs/using-the-api/webhooks/create-consumer.md +++ b/docs/using-the-api/webhooks/create-consumer.md @@ -72,6 +72,14 @@ A message will be delivered every time any of the company’s tags match the tag ![A fragment of the webhook UI that allows you to add company tags to a consumer](/img/use-the-api/webhooks-add-company-tags.png) +### Endpoint rate limits + +If your application can only handle a limited number of requests in a given time period, set a rate limit on the consumer endpoint to protect it from overloading. The rate limit is defined as a maximum number of messages per second to send to that endpoint. + +After the limit is reached, the frequency of requests will be reduced not to exceed it. The actual rate of messages can sometimes be slightly above the enforced rate limit. + +webhookratelimits + ## View webhook consumers In the [Codat Portal](https://app.codat.io/monitor/events), navigate to **Monitor > Webhooks > Events** to see the list of all consumer endpoints you have configured. @@ -499,16 +507,6 @@ svix verify --secret whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw --msg-id msg_p5jXN8A -## Endpoint Rate Limits - -If your application can only handle a limited number of requests in a given time period, you can protect it from becoming overloaded by setting a rate limit on a given endpoint. - -The rate limit is defined as a maximum number of messages per second to send to that endpoint. After the limit is reached, requests will get throttled to keep their frequency under the defined limit. - -Please note that the actual rate of messages can sometimes be slightly above the enforced rate limit. - -webhookratelimits - ## Transform webhook properties You may want to modify a webhook's properties (e.g. HTTP method, target URL, and message schema) before it is sent to your application to better fit your needs. To do so, you can now apply a transformation to the webhook following these steps: