---
title: "request.rate_limit.soft"
method: POST
path: "request.rate_limit.soft"
tags: ["Webhook"]
---

# request.rate_limit.soft

`POST request.rate_limit.soft` (webhook)

Sent when a request approached the configured rate-limit for a given action

## Payload

- SoftRateLimitExceededEvent — Sent when a request approached the configured rate-limit for a given action
  - `data` SoftRateLimitExceededEventData, required — Sent when a request approached the configured rate-limit for a given action
    - `action` 'create-message', required — The action being performed that triggered a request rate-limit - `create-message`: Creating a message (in the Dispatch/Webhooks application).
    - `orgId` string, required — The environment against which the request was made that triggered the limit
    - `rateLimit` integer, required — The configured rate-limit for this action in this environment
    - `requestRate` integer, required — The number of requests per second in the second where this event triggered
  - `type` 'request.rate_limit.soft', required

## Acknowledgement `2XX`

Return any 2XX status to indicate that the data was received successfully

---

[API](https://skmtc.dev/svix/apis/svix-api.md) · [All operations](https://skmtc.dev/svix/apis/svix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/svix/apis/svix-api/revisions/53a5efe353ad?raw)