Addresses
Receive notifications when addresses are created or updated.
Overview
Address webhooks notify your application when a customer's address is created or modified. Use these events to keep your systems in sync with customer address data.
Use Cases
- Sync new addresses to your CRM or fulfillment system
- Update shipping information when customers move
- Validate addresses for shipping eligibility
- Audit address changes for compliance
- Trigger re-verification when key fields change
Events
| Event | Description |
|---|---|
address.created | A new address was added to a customer's account |
address.updated | An existing address was modified |
address.created
Triggered When
- A customer adds a new shipping or billing address via the SDK API (checkout flow or account settings)
- An address is created via the Core API
- An administrator creates an address for a membership member from the Platform
- An address is created during a data import via the Platform Import Tool
Note: If the address is the customer's first address of its type (shipping or billing), it is automatically set as the default.
Payload
{
"type": "address.created",
"id": "evt_a1b2C3d4E5f6g7H8i9J0k1L2",
"created": 1704067200,
"data": {
"address": {
"object": "address",
"id": 12345,
"city": "New York",
"company": "Acme Inc",
"country": "US",
"country_name": "United States",
"created_at": 1704067200,
"department": null,
"first_name": "John",
"is_default": true,
"last_name": "Doe",
"line1": "123 Main Street",
"line2": "Suite 100",
"postal_code": "10001",
"salutation": "Mr",
"site_ids": [1, 2],
"state": "NY",
"state_name": "New York",
"title": null,
"type": "shipping",
"updated_at": 1704067200
}
}
}address.updated
Triggered When
- A customer edits their address via the SDK API (account settings)
- An address is updated via the Core API
- An address is updated during a data import via the Platform Import Tool
Payload
The payload includes a previous_attributes object containing only the fields that changed.
{
"type": "address.updated",
"id": "evt_m3N4o5P6q7R8s9T0u1V2w3X4",
"created": 1704153600,
"data": {
"address": {
"object": "address",
"id": 12345,
"city": "Los Angeles",
"company": "Acme Inc",
"country": "US",
"country_name": "United States",
"created_at": 1704067200,
"department": null,
"first_name": "John",
"is_default": true,
"last_name": "Doe",
"line1": "456 Oak Avenue",
"line2": null,
"postal_code": "90001",
"salutation": "Mr",
"site_ids": [1, 2],
"state": "CA",
"state_name": "California",
"title": null,
"type": "shipping",
"updated_at": 1704153600
},
"previous_attributes": {
"line1": "123 Main Street",
"line2": "Suite 100",
"city": "New York",
"state": "NY",
"postal_code": "10001"
}
}
}Payload Fields
| Field | Type | Description |
|---|---|---|
object | string | Object type identifier, always address |
id | integer | Unique identifier for the address |
city | string | City |
company | string | Company name |
country | string | Two-letter ISO country code |
country_name | string | Full country name |
created_at | integer | Unix timestamp when the address was created |
department | string | Department name |
first_name | string | First name |
is_default | boolean | Whether this is the customer's default address for its type |
last_name | string | Last name |
line1 | string | Street address line 1 |
line2 | string | Street address line 2 (apartment, suite, etc.) |
postal_code | string | ZIP or postal code |
salutation | string | Salutation (Mr, Mrs, Ms, etc.) |
site_ids | array | List of site IDs the customer belongs to |
state | string | State or province code |
state_name | string | Full state or province name |
title | string | Professional title |
type | string | Address type: shipping or billing |
updated_at | integer | Unix timestamp when the address was last modified |
Related
- Webhooks Overview - Setup, signatures, and configuration
Updated about 3 hours ago