For the complete documentation index, see llms.txt. This page is also available as Markdown.

Address

Sample payloads for address.created, address.updated and address.deleted.

address.created and address.updated carry the full address object. address.deleted carries only the id — the record is gone, so there is nothing else to send.

address.created

{
    "event": "address.created",
    "data": {
        "address_id": "AD-00632494667",
        "city": "Lagos",
        "coordinates": {
            "lat": 6.5969424,
            "lng": 3.3542992
        },
        "country": "NGA",
        "email": "buyer@example.com",
        "first_name": "Augustus",
        "id": "d799c2679e644279b59fe661ac8fa488",
        "is_residential": true,
        "last_name": "Obi",
        "line1": "1121 Allen Avenue, Ikeja",
        "line2": "",
        "metadata": {
            "my_app_customer_id": 11234
        },
        "name": "Augustus Obi",
        "phone": "+2348100000000",
        "state": "Lagos",
        "zip": "121006",
        "created_at": "2026-09-13T20:25:53.011Z",
        "updated_at": "2026-09-13T20:25:53.011Z"
    }
}

address.updated

Same shape as address.created, with the new values and a later updated_at.

address.deleted

Was this helpful?