Sign in

Called when your client’s requests to Codat's API exceed the allocated quota.

Note: This event type is deprecated. Developers should now use the client.rateLimit.reached event for handling rate limit notifications.

postWebhookClient rate limit reached

Payload

ClientIdstring uuid

Unique identifier for your client in Codat.

ClientNameClientName — unresolved $ref
RuleIdRuleId — unresolved $ref
RuleTypeRuleType — unresolved $ref
AlertIdAlertId — unresolved $ref
MessageMessage — unresolved $ref
DataClientRateLimitReachedWebhookData — unresolved $ref

Example payload

{
  "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
  "ClientName": "Bank of Dave",
  "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
  "RuleType": "Rate Limit Reached",
  "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  "Message": "The current daily rate limit quota of 1000 requests for bae71d36-ff47-420a-b4a6-f8c9ddf41140 has been reached.",
  "Data": {
    "DailyQuota": 1000,
    "ExpiresUtc": "2023-05-03T00:00:00Z"
  }
}

Response

Return a 200 status to indicate that the webhook was received successfully.

Changes