• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
You are viewing an old version of the API

Loyalty program updated

EVENT loyalty.program.updated

Published when a loyalty program is updated.


Permissions
LOYALTY_READ
Name Description
merchant_id
string

The ID of the target merchant associated with the event.

type
string

The type of event this represents, "loyalty.program.updated".

event_id
string

A unique ID for the webhook event.

created_at
string

Read only Timestamp of when the webhook event was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

data
LoyaltyProgramUpdatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "C337NFWQT2A6W",
  "type": "loyalty.program.updated",
  "event_id": "b10404b2-08c4-4c66-9299-c11feceb43dd",
  "created_at": "2020-05-13T01:38:42.785Z",
  "data": {
    "type": "loyalty",
    "id": "5216e8b2-d43e-41e2-9ed8-eccf3e892aef",
    "object": {
      "loyalty_program": {
        "id": "5216e8b2-d43e-41e2-9ed8-eccf3e892aef",
        "location_ids": [
          "2Z3BMKQB939X0"
        ],
        "status": "ACTIVE",
        "terminology": {
          "one": "Point",
          "other": "Points"
        },
        "accrual_rules": [
          {
            "accrual_type": "SPEND",
            "excluded_category_ids": [
              "7ZERJKO5PVYXCVUHV2JCZ2UG",
              "FQKAOJE5C4FIMF5A2URMLW6V"
            ],
            "excluded_item_variation_ids": [
              "CBZXBUVVTYUBZGQO44RHMR6B",
              "EDILT24Z2NISEXDKGY6HP7XV"
            ],
            "points": 1,
            "spend_amount_money": {
              "amount": 100
            }
          }
        ],
        "reward_tiers": [
          {
            "id": "927cab58-09cd-410f-aa68-a44015d8bbbb",
            "name": "5% off entire sale",
            "points": 5,
            "definition": {
              "discount_type": "FIXED_PERCENTAGE",
              "percentage_discount": "5",
              "scope": "ORDER"
            },
            "created_at": "2019-08-19T18:22:45Z",
            "pricing_rule_reference": {
              "object_id": "ZKFKBH5IINTZLY3VA2OWIFX3",
              "catalog_version": "1603960067138"
            }
          },
          {
            "id": "aa5373ef-191d-4cb5-b122-8e8de41ab32f",
            "name": "20% off entire sale",
            "points": 15,
            "definition": {
              "discount_type": "FIXED_PERCENTAGE",
              "percentage_discount": "20",
              "scope": "ORDER"
            },
            "created_at": "2020-05-13T01:38:40Z",
            "pricing_rule_reference": {
              "object_id": "74C4JSHESNLTB2A7ITO5HO6F",
              "catalog_version": "1605486402527"
            }
          }
        ],
        "created_at": "2019-08-19T18:22:46Z",
        "updated_at": "2020-05-13T01:38:40Z"
      }
    }
  }
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?