Skip to main content

Address

v1

Description

Notifies when the Address event is triggered by the user. Address Webhook event data for create, update and delete event.


Supported type

  • Create
  • Update
  • Delete

Payload

Create


{
"payload": {
"address": {
"_id": "64900d6f9c3b49cb375b77c4",
"country": "India",
"checkout_mode": "self",
"sector": "noida",
"state_code": "MH62",
"tags": [],
"state": "Maharashtra",
"area_code": "400070",
"area": "Aashiyana CHS opposite Fauziya hospital ",
"_custom_json": {},
"name": "Imran khan",
"address_type": "home",
"is_default_address": false,
"app_id": "62f35968d101a6d38c886d85",
"landmark": "lbs road kurla west",
"area_code_slug": "pincode",
"address_type": "home",
"email": null,
"expire_at": null,
"city": "Mumbai",
"uid": 953,
"country_code": "91",
"address": "B 302 ",
"user_id": "62fb2f693f91c33ded7c5574",
"phone": 8419963228
}
},
"meta": {
"event": {
"name": "address",
"type": "create",
"version": "1"
},
"service": {
"name": "megatron"
},
"company_id": 2,
"application_id": "62f35968d101a6d38c886d85",
"trace_id": [
"megatron.0bc88001-2dd5-4e1f-81d6-a815d2bc7196"
],
"created_timestamp": 1687162223330
}
}

Update

    
{
"payload": {
"address": {
"geo_location": {
"latitude": 19.0653019,
"longitude": 72.8423396
},
"area_code_slug": "pincode",
"checkout_mode": "self",
"sector": "noida",
"state_code": "MH62",
"state": "Maharashtra",
"name": "Neel Gajjar",
"address": "123",
"address_type": "home",
"country_code": "91",
"area": "dsfdf ggh fd fd f ff",
"_custom_json": {},
"uid": 777,
"_id": "648c017f1b6aaec47974fc89",
"is_default_address": true,
"expire_at": "2023-09-14T10:34:12.210000+00:00",
"country": "India",
"landmark": "fd f df df eeee",
"city": "Mumbai",
"tags": []
}
},
"meta": {
"event": {
"name": "address",
"type": "update",
"version": "1"
},
"service": {
"name": "megatron"
},
"company_id": 2,
"application_id": "62f35968d101a6d38c886d85",
"trace_id": [
"megatron.740569bb-2f85-4e70-b21e-3f7eba253624"
],
"created_timestamp": 1686911652215
}
}

Delete

    
{
"payload": {
"address": {
"name": "wksjd",
"expire_at": null,
"area_code_slug": "pincode",
"landmark": "qwdakljsh",
"geo_location": {
"latitude": 19.0653252,
"longitude": 72.8423802
},
"state": "Rajasthan",
"sector": "noida",
"state_code": "MH62",
"_custom_json": {},
"city": "Jaipur",
"country_code": "91",
"is_default_address": true,
"uid": 1021,
"area": "wekdjh",
"app_id": "6343dc33a36c2f7963c226e9",
"country": "India",
"_id": "6490218b33fe83bd14cd4873",
"email": null,
"checkout_mode": "self",
"area_code": "302020",
"user_id": "648c288d7f7f366d822c6c73",
"phone": 9876543234,
"address_type": "home",
"address": "wekjadn",
"tags": []
}
},
"meta": {
"event": {
"name": "address",
"type": "delete",
"version": "1"
},
"service": {
"name": "megatron"
},
"company_id": 2,
"application_id": "6343dc33a36c2f7963c226e9",
"trace_id": [
"megatron.5d05f4f0-1c4f-4213-a7de-1cbb5f5f5b66"
],
"created_timestamp": 1687168551064
}
}

Object Properties

NameTypeDescriptionRequired
nameStringName of the userYes
addressStringFlat No/House No/Building NoYes
emailString/NullEmail id of userNo
phoneStringPhone number of userYes
areaStringBuilding Name/ Street*Yes
landmarkStringLandmarkYes
checkout_modeStringCheckoout type of userYes
user_idStringUser Id of the useryes
uidIntUnique identifier of the address objectYes
is_default_addressBooleanBoolean for default address of userYes
cityStringCity nameYes
stateStringState nameyes
countryStringCountry nameyes
country_codeStringCountry codeyes
_custom_jsonJsonCustom data for address/userNo
area_code_slugStringSlug for area code e.g. pincode or zipcodeYes
app_idStringApplication idYes
area_codeStringPincode of the areaYes
geo_locationJSONGeographic location e.g. latitude/longitudeYes
_idStringUnique identifier for the address mongo objectYes
address_typeStringAddress type e.g. Home or workYes
tagsArrayNO
expire_atString/NullNO
metaJSONMeta data for the addressNo
sectorStringSector will represent the sector for that addressNo
state_codeStringSector will represent the code for that stateNo
address_typeStringThis would represent the name of the addressNo