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

Loyalty event created BETA

EVENT loyalty.event.created

Published when a loyalty event is created.


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.event.created".

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
LoyaltyEventCreatedWebhookData

Data associated with the event.

Examples

You are viewing an old version of the API
Example payload
{
  "merchant_id": "C337NFWQT2A6W",
  "type": "loyalty.event.created",
  "event_id": "f151e2c6-9340-4cca-9d37-1bcd1c2d6a0d",
  "created_at": "2020-05-13T01:46:58.783Z",
  "data": {
    "type": "loyalty",
    "id": "iirpaae81f66e-a7ea-4fcf-a04f-f0d29fdc60e6",
    "object": {
      "loyalty_event": {
        "id": "d0bd89a5-3d04-389e-a54b-4e509658fe41",
        "location_id": "2Z3BMKQB939X0",
        "loyalty_account_id": "ba2f8ab6-e131-46d9-9882-17714404eb49",
        "source": "SQUARE",
        "type": "ADJUST_POINTS",
        "adjust_points": {
          "loyalty_program_id": "5216e8b2-d43e-41e2-9ed8-eccf3e892aef",
          "points": 10
        },
        "created_at": "2020-05-13T01:46:58Z"
      }
    }
  }
}

Share Feedback

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