⚙️Rate Limit Exceeded

api.rate_limit_exceeded
v1.0

Triggered when an API key exceeds its rate limit

Subscribe

Webhook Delivery

This event can be delivered to your webhook endpoint

Real-time Streaming

This event does not support real-time streaming

Event Details

Schema definition and example payload

Event Properties

object
apiKeyId
string
required

API key that exceeded limit

limit
number
required

Rate limit threshold

window
string
required

Time window (e.g., "1h")

exceededAt
string
required
date-time

Integration Examples

Example code for handling this event

// Handle api.rate_limit_exceeded event
app.post('/webhook', async (req, res) => {
  const event = req.body;
  
  if (event.type === 'api.rate_limit_exceeded') {
    // Process the event
    console.log('Received Rate Limit Exceeded:', event.data);
    
    // Your business logic here
    
    
    
  }
  
  res.status(200).json({ received: true });
});