Link Search Menu Expand Document

Notification webhook

Triggered as a result of a 200OK response from the send-notification endpoint.

The object returned as a result of registering to this webhook is as follows:

{
    "type": "shopper.notification",
    "id": "user:3627395",
    "chain_id": 1743,
    "created": "2022-10-11T10:02:03Z",
    "mute": false,
    "data": {
        "message": {
            "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur posuere orci posuere arcu hendrerit, at pharetra sapien egestas. Praesent sagittis sit amet purus et blandit. Duis pharetra viverra lectus ac commodo. Fusce eget fermentum lacus, eget tincidunt massa. Nullam et orci sed ex laoreet sollicitudin vitae ornare nibh. Sed sit amet tellus nisi. Aenean sit amet blandit elit.",
            "subject": "Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..."
        },
        "referral_email": "joe.bloggs@example.com",
        "referral_phone_number": "1234567890",
        "referral_type": "email",
        "user": {
            "Deleted": false,
            "ResetLink": "",
            "address_address_regionstate": "",
            "address_housenumber": "",
            "address_housenumber_extension": "",
            "address_latitude": 0,
            "address_line_2": "",
            "address_line_3": "",
            "address_longitude": 0,
            "address_postalcode": "",
            "address_streetname": "",
            "address_towncity": "",
            "authentication_point": {
                "id": 0,
                "is_multi": false
            },
            "authentication_point_identifier": "23t24ty3464373",
            "auxiliary_identifier": "",
            "average_basket_value": "0.00",
            "birthday": "",
            "brands": "",
            "country_code": "",
            "created_date": "",
            "days_since_last_purchase": 0,
            "first_name": "John",
            "frequency": 0,
            "gender": "",
            "home_store": {
                "home_store_id": null,
                "home_store_name": "",
                "home_store_owner_code": ""
            },
            "id": 3627395,
            "is_employee": false,
            "is_influencer": false,
            "language": "",
            "last_login_date": "",
            "last_loyalty_activity_date": "",
            "last_modified_date": "",
            "last_name": "Smith",
            "last_purchase_date": "",
            "loyalty_status": {
                "campaign_id": 0,
                "date_reached": "",
                "description": "",
                "last_review_date": "",
                "loyalty_level_id": 0,
                "monetary_balance_current": 0,
                "name": "",
                "next_review_date": "",
                "points_balance_current": 0,
                "points_to_proceed_next_level": 0,
                "points_to_remain_current_level": 0
            },
            "mailing_list": {
                "mailing_list_subscribed": false,
                "printed_mailing_list_subscribed": false
            },
            "member_number": {
                "code": "3627395",
                "type": "regular"
            },
            "monetary": 0,
            "number_of_purchases": 0,
            "obfuscated": false,
            "offline_shopper": false,
            "online_shopper": false,
            "opt_in_programme": {
                "join_date": "2020-04-07T15:41:54+00:00",
                "programme_opted_in": true
            },
            "opt_in_secondary": false,
            "overall": 0,
            "phone_number": "",
            "points_wallet_balance": null,
            "push_notification_subscription": {
                "subscribed": false,
                "subscriptions": []
            },
            "recency": 0,
            "referral": {},
            "referral_channel": "",
            "referral_code": "h4u8db",
            "referred": false,
            "registered": true,
            "signup_channel": "webshop",
            "signup_store_id": 0,
            "signup_store_name": "",
            "signup_store_owner_code": "",
            "spaaza_join_date": "",
            "stores": "",
            "total_cashback_balance": 0,
            "user_id": 3627395,
            "username": "john.smith@spaaza.com"
        }
    },
    "meta": null
}