Account Expired
An Account expired webhook is fired when an address look-up request is received from an expired account.
GET https://api.getAddress.io/webhook/expired/{id}?api-key={admin-key}
GET https://api.getAddress.io/webhook/expired?api-key={admin-key}
POST https://api.getAddress.io/webhook/expired?api-key={admin-key}
POST https://api.getAddress.io/webhook/expired/test?api-key={admin-key}
DELETE https://api.getAddress.io/webhook/expired?api-key={admin-key}
Examples
Adds URL (endpoint) to be called
Request
POST https://api.getAddress.io/webhook/expired?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/expired/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":"expired", "created_at":10/13/2024 10:08:22 AM, "details": { "update_card_details_link":"https://admin.getaddress.io" }, "type":"billing" }