All Versions

Loyalty event created

EVENT loyalty.event.created

Published when a loyalty event is created.

Permissions

LOYALTY_READ

Event payload

Example code

Name	Description
`merchant_id string`	The ID of the Square seller associated with the event.
`type string`	The type of event. For this event, the value is `loyalty.event.created`.
`event_id string`	The unique ID for the event, which is used for idempotency support.
`created_at string`	Read only The 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`	The data associated with the event.

Examples

All Versions

{
  "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"
      }
    }
  }
}