Webhooks Rate Limits and Quotas
The Webhooks service observes a set of rate limits to ensure that all clients get sufficient service and that runaway applications don’t consume excessive resources. APS Rate Limits and Quotas describes rate limits in general.
Rate Limits
These rate limits apply to each of the Webhook’s API’s endpoints. Note that these rates are not service guarantees. In the uncommon case where total service use is too high across all clients, accepted request rates may drop until traffic subsides.
Scope
The Webhooks service sets a separate rate limit for each application (specified by client ID) per API endpoint. For example, an application can’t exceed the specified limit of 300 requests per minute when calling the API endpoint GET systems/:system/events/:event/hooks/:hook_id.
The application can, however, exceed 300 combined requests per minute if those requests go to separate endpoints and requests to each endpoint don’t violate each endpoint’s specified rate limit. For example, an application could make 320 requests per minute if 290 requests go to GET systems/:system/events/:event/hooks/:hook_id (limit 300) and 30 go to POST systems/:system/events/:event/hooks (limit 50).
Violation Notification
If an application exceeds an endpoint’s rate limit, the Webhooks service returns an HTTP 429 error (described in detail in APS Rate Limits and Quotas).
Webhooks Endpoint Rate Limits
These rate limits apply to webhooks endpoints within the Webhooks API.
Method | Endpoint | Limit (requests/minute) |
---|---|---|
GET | systems/:system/events/:event/hooks/:hook_id | 300 |
GET | systems/:system/events/:event/hooks | 300 |
GET | systems/:system/hooks | 300 |
GET | hooks | 300 |
POST | systems/:system/events/:event/hooks | 50 |
POST | systems/:system/hooks | 50 |
PATCH | systems/:system/events/:event/hooks/:hook_id | 300 |
DELETE | systems/:system/events/:event/hooks/:hook_id | 300 |
Tokens Endpoint Rate Limits
These rate limits apply to tokens endpoints within the Webhooks API.
Method | Endpoint | Limit (requests/minute) |
---|---|---|
POST | tokens | 50 |
PUT | tokens/@me | 50 |
DELETE | tokens/@me | 50 |
Quotas
Webhooks quotas limit an app’s resource consumption when using the Webhooks service.
Scope
Quotas are enforced for each event type for a given scope.
Event Type Quotas
The Webhooks service has a Event Type Quota of 1000 hooks per event type for a given scope. Note that you are not allowed to register the same callback URL more than once for the same scope and event type.
Quota Violation Notification
The Webhooks service returns an HTTP 400 error, with the message “Failed to create more than 1000 hooks for same scope” if an application attempts to go past the quota.
Changing Limits
APS Rate Limits and Quotas describes how to request rate limit changes for APS APIs.