Skip to content

Commit 1bedcd5

Browse files
authored
Merge pull request #1632 from codatio/pj-simpson-webhook-rate-limits
Update create-consumer.md
2 parents 1e94a2c + 07eab4e commit 1bedcd5

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/using-the-api/webhooks/create-consumer.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,14 @@ A message will be delivered every time any of the company’s tags match the tag
7272

7373
![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)
7474

75+
### Endpoint rate limits
76+
77+
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.
78+
79+
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.
80+
81+
<img width="740" height="446" alt="webhookratelimits" src="https://github.com/user-attachments/assets/6afec3df-eae3-4815-90e0-ee17bc1ee9d7" />
82+
7583
## View webhook consumers
7684

7785
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.

0 commit comments

Comments
 (0)