Sign in

Called when the rate limit quota has reset for the client, and more requests to Codat's API are available.

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

postWebhookClient rate limit reset

Payload

ClientIdstring uuid

Unique identifier for your client in Codat.

ClientNamestring

Name of your client in Codat.

RuleIdstring uuid

Unique identifier for the rule.

RuleTypestring

The type of rule.

AlertIdstring uuid

Unique identifier of the webhook event.

Messagestring

A human-readable message about the webhook.

DataClientRateLimitResetWebhookData — unresolved $ref

Example payload

{
  "ClientId": "bae71d36-ff47-420a-b4a6-f8c9ddf41140",
  "ClientName": "Bank of Dave",
  "RuleId": "70af3071-65d9-4ec3-b3cb-5283e8d55dac",
  "RuleType": "Rate Limit Reset",
  "AlertId": "a9367074-b5c3-42c4-9be4-be129f43577e",
  "Message": "The current daily rate limit quota for client 30e0f9d2-52c0-4c9f-a806-bcd98a3bcd7e has been reset to 1000 requests.",
  "Data": {
    "QuotaRemaining": 1000,
    "ResetReason": "The quota was reset because it is a new day.",
    "DailyQuota": 1000,
    "ExpiresUtc": "2023-05-03T00:00:00Z"
  }
}

Response

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

Changes