docs
  1. SCAYLE Developer Guides
  2. Customise & Extend
  3. Webhooks
  4. Events
  5. Address-created

address-created

Get notified whenever a customer saves a new address.

Example:

{
    "customer": {
        "id": 9876,
        "anonymisation": {
            "status": "initiated"
        },
        "authentication": {
            "type": "password"
        },
        "birthDate": "1981-02-02",
        "customData": {
            "isVip": true
        },
        "email": "[email protected]",
        "firstName": "Anna",
        "gender": "f",
        "groups": [
            "employee",
            "vip"
        ],
        "identities": [
            {
                "idpCode": "keycloak"
            },
            {
                "externalUserId": "123",
                "idpCode": "okta"
            }
        ],
        "ipAddress": "172.19.0.2",
        "lastName": "Fohlmeister",
        "phone": "0049/1234567890",
        "publicKey": "customer-1234",
        "referenceKey": "customer-1234",
        "status": {
            "isActive": false,
            "isAnonymous": true,
            "isGuestCustomer": false,
            "isTestCustomer": false
        },
        "title": "Dr.",
        "type": "retail",
        "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 11_2_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.90 Safari/537.36",
        "createdAt": "2018-01-20T09:30:15+00:00",
        "updatedAt": "2018-01-20T09:30:15+00:00"
    },
    "key": "1f3e35e7-92b0-4ad2-b596-a215615398d4",
    "locale": {
        "appId": 999,
        "countryCode": "DEU",
        "languageCode": "de-DE"
    },
    "occurredAt": "2018-01-20T09:30:15+00:00",
    "payload": {
        "id": 998,
        "additional": "c/o AboutYou",
        "city": "Hamburg",
        "countryCode": "DEU",
        "houseNumber": "12",
        "isDefault": {
            "billing": false,
            "shipping": false
        },
        "phone": "089999123",
        "recipient": {
            "firstName": "Anna",
            "gender": "m",
            "lastName": "Fohlmeister",
            "type": "personal"
        },
        "referenceKey": "address-7656",
        "state": "Sachsen",
        "street": "Wolfgangsweg",
        "zipCode": "20459",
        "createdAt": "2018-01-20T09:30:15+00:00",
        "updatedAt": "2018-01-20T09:30:15+00:00"
    },
    "type": "address-created"
}

Properties:

  • customer object (optional)
    • id integer
    • anonymisation object (optional)
      • status enum (initiated pending executed cancelled)
    • authentication object (optional)
      • data object (optional)
      • type enum (facebook password apple)
    • birthDate string (optional)
    • customData object (optional) (object is extensible as desired)
    • email string (optional) (maximum length: 60)
    • firstName string
    • gender enum (m f d n) (optional)
    • groups array (optional)
      • false string (optional) (minimum length: ) (maximum length: 60)
    • identities array (optional)
      • externalUserId string,null (optional) (minimum length: ) (maximum length: 255)
      • idpCode string (minimum length: ) (maximum length: 255)
    • ipAddress string (optional)
    • lastName string
    • phone string (optional)
    • publicKey string (optional) (minimum length: ) (maximum length: 100)
    • referenceKey string (optional) (minimum length: ) (maximum length: 100)
    • status object
      • isActive boolean
      • isAnonymous boolean
      • isGuestCustomer boolean
      • isTestCustomer boolean
    • title null,string (optional) (maximum length: 30)
    • type enum (personal retail organization family)
    • userAgent string (optional)
    • createdAt string (date-time ISO 8601)
    • updatedAt string (date-time ISO 8601)
  • key string
  • locale object
    • appId integer
    • countryCode string (minimum length: ) (maximum length: 3)
    • currencyCode string (optional) (minimum length: ) (maximum length: 3)
    • languageCode string (minimum length: ) (maximum length: 5)
  • occurredAt string
  • payload object
    • id integer
    • additional string (optional)
    • city string
    • collectionPoint object (optional)
      • customerKey string (optional)
      • description string (optional)
      • key string
      • type string (minimum length: ) (maximum length: 64)
    • countryCode string (minimum length: ) (maximum length: 3)
    • houseNumber string (optional)
    • isBillingAddress boolean (optional)
    • isDefault object
      • billing boolean
      • shipping boolean
    • isShippingAddress boolean (optional)
    • phone string (optional)
    • recipient object
      • firstName string
      • gender enum (m f d n) (optional)
      • lastName string
      • title string (optional) (minimum length: ) (maximum length: 100)
      • type enum (personal retail organization family)
    • referenceKey string (optional) (minimum length: ) (maximum length: 100)
    • state string,null (optional) (minimum length: ) (maximum length: 60)
    • street string
    • zipCode string (optional)
    • createdAt string (date-time ISO 8601) (optional)
    • updatedAt string (date-time ISO 8601) (optional)
  • type enum (address-created)