{
"id": "paywall_usage_rate_limited_evt_123",
"paywallId": "pw_live_123",
"ownerUserId": "usr_owner_789",
"type": "usage.rate.limited",
"version": "2024-05-01",
"createdAt": "2024-05-01T12:34:56Z",
"status": "pending",
"attempts": 1,
"data": {
"paywallId": "pw_live_123",
"ownerUserId": "usr_owner_789",
"limit": 1000,
"date": "2024-05-01",
"model": "gpt-4o-mini",
"walletUserId": "wallet_123"
}
}Webhook events
Usage rate limited
Triggered when a request hits the usage rate limit. Notifies when a request is rate-limited so teams can monitor free-tier consumption. Payload fields: paywallId, ownerUserId, limit, date, model, walletUserId.
WEBHOOK
usage.rate.limited
{
"id": "paywall_usage_rate_limited_evt_123",
"paywallId": "pw_live_123",
"ownerUserId": "usr_owner_789",
"type": "usage.rate.limited",
"version": "2024-05-01",
"createdAt": "2024-05-01T12:34:56Z",
"status": "pending",
"attempts": 1,
"data": {
"paywallId": "pw_live_123",
"ownerUserId": "usr_owner_789",
"limit": 1000,
"date": "2024-05-01",
"model": "gpt-4o-mini",
"walletUserId": "wallet_123"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Paywall event payload that triggered the webhook delivery.
Event key (see the webhooks section for the full catalog).
Available options:
updated, archived, secret.rotated, integration.connected, integration.disconnected, integration.stripe.webhook.rotated, authorization.requested, authorization.completed, authorization.revoked, authorization.declined, balance.deposit.created, balance.topup.link.created, balance.trial.granted, balance.charge.created, balance.charge.completed, balance.charge.failed, usage.charge.created, usage.charge.deferred, usage.rate.limited, balance.depleted, request.blocked, stripe.checkout.session.completed, proxy.request.started, proxy.request.completed, proxy.request.failed, proxy.request.canceled, proxy.request.blocked Allowed value:
"usage.rate.limited"Payload fields: paywallId, ownerUserId, limit, date, model, walletUserId.
Response
200
Return a 2xx to acknowledge receipt.