Link Search Menu Expand Document

Loyalty level changed webhook

Triggered as a result of a user’s loyalty level changing.

Section Description
loyalty_level Information about the new loyalty level including the name and description of the level.
user Information about the user including their name, member number, email and address information.

Note that the ‘data’ section of the webhook payload includes information about the user whose status has changed and about the new level:

An example of a loyalty status level webhook

{
    "type": "shopper.loyalty-level-changed",
    "id": "5b69c11f4bf8c",
    "chain_id": 1743,
    "created": "2018-08-07T15:56:15Z",
    "data": {
        "campaign_id": 201,
        "created_date": "2018-08-07T15:56:15+00:00",
        "id": 80007,
        "log_message": "Manual level change",
        "loyalty_level": {
            "automated_level_logic": true,
            "campaign_id": 201,
            "description": "Silver level in the ACME Programme",
            "id": 4,
            "name": "member"
        },
        "loyalty_level_previous": {
            "automated_level_logic": true,
            "campaign_id": 201,
            "description": "Bronze level in the ACME Programme",
            "id": 18,
            "name": "Bronze"
        },
        "mutation_owner_id": 1,
        "user": {
            "address_housenumber": null,
            "address_housenumber_extension": null,
            "address_line_2": null,
            "address_line_3": null,
            "address_postalcode": null,
            "address_regionstate": null,
            "address_streetname": null,
            "address_towncity": null,
            "authentication_point_identifier": "66141993",
            "auxiliary_identifier": "peb209883x",
            "birthday": "1988-05-06T00:00:00+00:00",
            "country_code": "NL",
            "first_name": "Sam",
            "gender": "M",
            "id": 34348394,
            "language": "nl-NL",
            "last_name": "Critchley",
            "loyalty_status": {
                "campaign_id": 201,
                "name": "Silver",
                "description": "Silver level in the ACME Programme",
                "loyalty_level_id": 4,
                "points_balance_current": 340,
                "points_to_proceed_next_level": 410,
                "points_to_remain_current_level": 60,
                "last_review_date": "2019-06-28T09:30:40+00:00",
                "next_review_date": "2020-06-28T09:30:40+00:00",
                "date_reached": "2019-08-23T13:33:15+00:00"
            },
            "mailing_list": {
                "mailing_list_sub_offered": false,
                "mailing_list_subscribed": true,
                "printed_mailing_list_subscribed": false
            },
            "member_number": {
                "code": "30359901",
                "type": "custom"
            },
            "opt_in_programme": {
                "programme_opted_in": true,
                "join_date": "2019-06-06T08:06:14+00:00"
            },
            "opt_in_secondary": false,
            "push_notification_subscription": {
                "subscribed": false,
                "subscriptions": []
            },
            "referral_channel": "store",
            "referral_code": "ptola9",
            "referring_user": {
                "authentication_point_identifier": "2152416",
                "campaign_id": 2067,
                "id": 3593704,
                "referral_channel": "webshop",
                "referral_code": "b09zy7"
            },
            "registered": true,
            "signup_channel": "webshop",
            "user_id": 34348394,
            "username": "acmestage691228534@cowcam.com"
        }
    }
}