First Limit Reached
Fired when a plan's daily limit is reached.
GET https://api.getAddress.io/webhook/first-limit-reached/{id}?api-key={admin-key}
GET https://api.getAddress.io/webhook/first-limit-reached?api-key={admin-key}
POST https://api.getAddress.io/webhook/first-limit-reached?api-key={admin-key}
POST https://api.getAddress.io/webhook/first-limit-reached/test?api-key={admin-key}
DELETE https://api.getAddress.io/webhook/first-limit-reached?api-key={admin-key}
Examples
Adds URL (endpoint) to be called
Request
POST https://api.getAddress.io/webhook/first-limit-reached?api-key={admin-key}
Request Body
{ "url": "https://your-domain.com/action" }
Response 200
{ "message": "Webhook : 'https://your-domain.com/action' has been created.", "id": "1" }Test
Sends a webhook to each added endpoint.
Request
POST https://api.getAddress.io/webhook/first-limit-reached/test?api-key={admin-key}
Response 200
{ "message": "Webhook has been sent" }
Data sent to each added endpoint in the request body
{ "version":"1.0.0.0", "action":"first_limit_reached", "created_at":11/8/2024 1:10:04 AM, "details": { "limit":50, "time_penaly":5000, "next_limit":100, "upgrade_link":"https://admin.getaddress.io" }, "type":"usage" }